Update Session
Request to add or update request fields contained in the session.
Authentication Copied to clipboard
This operation requires authentication via one of the following methods:
- Certificate authentication.
-
To authenticate to the API two additional NVP parameters must be supplied in the request.
Provide 'merchant.
<your gateway merchant ID>' in the apiUsername field and your API password in the apiPassword field.
Request Copied to clipboard
Fields Copied to clipboard
A commercial agreement you have with the payer that allows you to store and use their payment details for later payments.
For example, an agreement to a series of recurring payments (a mobile phone subscription), an agreement to take payment for a purchase by a series of installments (hire purchase), an agreement to make additional payments when required (account top up), or to fulfil a standard industry practice (no show penalty charge).
Do not provide this parameter group if you are storing the payment details for subsequent payer-initiated payments only.
See Credential on File, Cardholder, and Merchant Initiated Transactions for details.
Enumeration
OPTIONAL
Indicates if all the payments within the agreement use the same amount or if the amount differs between the payments.
The field must be provided for recurring payment agreements.
Value must be a member of the following list. The values are case sensitive.
FIXED
All payments in the recurring payment agreement have the same amount. Examples include magazine subscriptions or gym memberships.
VARIABLE
The amount for the payments within the recurring payment agreement differs between payments. Examples include usage-based charges like utility or phone bills.
String
OPTIONAL
Additional information requested for the agreement which cannot be passed using other available data fields.
This field must not contain sensitive data.
Data can consist of any characters, but sensitive data will be rejected
Date
OPTIONAL
Date at which your agreement with the payer to process payments expires.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
String
OPTIONAL
Your identifier for the agreement you have with the payer to process payments.
When you collect cards from your payers and store them for later use, you must provide an agreement ID when you use the stored values for:
- Recurring payments: you have an agreement with the payer that authorizes you to automatically debit their account at agreed intervals for fixed or variable amounts. For example, gym membership, phone bills, or magazine subscriptions.
- Installment payments: you have an agreement with the payer that authorizes you to process multiple payments over an agreed period of time for a single purchase. For example, the payer purchases an item for $1000 and pays for it in four monthly installments.
- Unscheduled: you have an agreement with the payer that authorizes you to process future payments when required. For example, the payer authorizes you to process an account top-up transaction for a transit card when the account balance drops below a certain threshold.
- Industry Practice: you have an agreement with the payer that authorizes you to initiate additional transactions to fulfil a standard business practice related to an original payment initiated by the payer. For example, a delayed charge for use of the hotel mini bar after the payer has checked out or a no show penalty charge when the payer fails to show for a booking.
Data can consist of any characters
Decimal
OPTIONAL
The maximum amount for a single payment in the series as agreed with the payer under your agreement with them.
The amount must be provided in the currency of the order.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Decimal
OPTIONAL
The minimum amount for a single payment in the series as agreed with the payer under your agreement with them.
The amount must be provided in the currency of the order.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Integer
OPTIONAL
The minimum number of days between payments agreed with the payer under your agreement with them.
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
Integer
OPTIONAL
The number of merchant-initiated payments within the recurring payment agreement.
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
Enumeration
OPTIONAL
The frequency of the payments within the series as agreed with the payer under your agreement with them.
Value must be a member of the following list. The values are case sensitive.
AD_HOC
The agreement if for payments on an ah-hoc basis.
DAILY
The agreement if for a daily payment.
FORTNIGHTLY
The agreement if for a fortnightly payment.
MONTHLY
The agreement if for a monthly payment.
OTHER
The agreement is for payments according to a schedule other than the ones listed in the other enumeration values for this field.
QUARTERLY
The agreement if for a quarterly payment.
TWICE_YEARLY
The agreement if for a payment twice a year.
WEEKLY
The agreement if for a weekly payment.
YEARLY
The agreement if for a yearly payment.
For an installment agreement where the payer purchased goods and/or services from a retailer but entered an installment agreement to pay for this purchase with you, you must provide details about the retailer.
String
OPTIONAL
Provide an abbreviation of the retailer's trading name that can be used by the issuer to indicate the retailer on the payer's statement.
Data can consist of any characters
String
OPTIONAL
A 4-digit code used to classify the retailer's business by the type of goods or services it offers.
Data can consist of any characters
String
OPTIONAL
The retailer's trading name.
Data can consist of any characters
Date
OPTIONAL
This is the effective start date for the payment agreement.
Cannot be in the past.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
Enumeration
OPTIONAL
The type of commercial agreement that the payer has with you.
Specify the agreement type when you have provided a value for agreement.id and this payment is the first in a series of payments. The default value is OTHER.
The gateway will use the value you specify for subsequent payments in the series.
Value must be a member of the following list. The values are case sensitive.
INSTALLMENT
An agreement where the payer authorizes the payment for a single purchase to be split into a number of payments processed at agreed intervals. For example, pay for a purchase in six monthly installments.
OTHER
An agreement where you want to link related payments for any purpose other than processing recurring, installment, or unscheduled payments. For example, split tender payments.
RECURRING
An agreement where the payer authorizes you to process repeat payments for bills or invoices at agreed intervals (for example, weekly, monthly). The amount might be fixed or variable.
UNSCHEDULED
An agreement where the payer authorizes you to automatically deduct funds for a payment for an agreed purchase when required (unscheduled). For example, auto top-ups when the account value falls below a threshold.
String
= UPDATE_SESSION
FIXED
Any sequence of zero or more unicode characters.
Information used to manage interactions with the payment provider if you are offering your payment page in an app or are redirecting the payer to the provider's app.
If you are offering your payment page on a website or are redirecting the payer's browser to the provider's website, use the browserPayment parameter group.
Url
OPTIONAL
The URL of your app to which you want the payer to be redirected on completing the payment interaction at the payment provider's website or in the payment provider's app.
The same return URL will be used by the gateway to redirect the payer irrespective of the success or otherwise of the payment interaction. This field is not required if the payer is to be redirected to your website or if the payment provider's checkout flow is presented on a modal window on top of your payment page.
Data must be an absolute URI conforming to the URI syntax published by IETF RFC 2396.
Information about how the payer's identity is verified.
For example, using 3-D Secure authentication.
This parameter group include payer authentication options available to you, parameters you need to perform payer authentication for an available method, and the results of payer authentication.
Information about payer authentication using 3-D Secure authentication.
Only provide these fields if you authenticated the payer using a different 3-D Secure service provider. If you authenticated the payer using the gateway, then provide authentication.transactionId instead.
Parameters in this group apply to both 3-D Secure authentication version 1 and 3-D Secure Authentication version 2.
Depending on the 3-D Secure authentication version applicable you will also need additional parameters:
- 3-D Secure authentication version 1: see the authentication.3ds1 parameter group.
- 3-D Secure authentication version 2: see the authentication.3ds2 parameter group.
Alphanumeric
OPTIONAL
Indicates the security level of the transaction.
This is the Electronic Commerce Indicator (ECI) value provided by the issuer's Access Control Server (ACS) to indicate the results of the attempt to authenticate the payer.
Data may consist of the characters 0-9, a-z, A-Z
Base64
OPTIONAL
The base64 encoded value generated by the issuer.
The authentication token Included in subsequent transaction request messages and used by the card scheme to verify that the authentication occurred and the values provided are valid. The token should be used unaltered.
For 3DS version 1, this field corresponds to the Cardholder Authentication Verification Value (CAVV) for Visa, the Accountholder Authentication Value (AAV) for MasterCard and JCB, or the American Express Verification Value (AEVV) for American Express.
For 3DS version 2, this field corresponds to the Authentication Value.
Data is Base64 encoded
String
OPTIONAL
A unique identifier for the 3-D Secure authentication transaction.
For 3DS version 1, this field corresponds to the XID. The XID is an identifier generated by the gateway on behalf of the merchant.
For 3DS version 2, this field corresponds to the identifier assigned by the scheme directory server.
This identifier should be used in subsequent operation requests unaltered.
An XID submitted in this field must be in base64 format.
Data can consist of any characters
Information about payer authentication using 3-D Secure authentication version 1.
Only provide these fields if you authenticated the payer using a different 3-D Secure service provider. If you authenticated the payer using the gateway, then provide authentication.transactionId instead.
Alpha
OPTIONAL
Indicates the result of payer authentication with the issuer.
This is the value returned in the transaction status field of the Payer Authentication Response (PARes) message from the card Issuer's Access Control Server (ACS). For example, Y, N, A, or U. Refer to the relevant documentation for Mastercard SecureCode™, Verified by Visa™, JCB J/Secure™, American Express SafeKey™, or Diners Club ProtectBuy™.
Data may consist of the characters a-z, A-Z
Alpha
OPTIONAL
Indicates whether or not payer authentication is available for the card number you provided.
This is for experts only - most users should use the response.gatewayRecommendation field.
This is the value returned in the 'enrolled' field of the Verify Enrollment Response (VERes) message from the card scheme's Directory Server. For example, Y, N, or U. Refer to the relevant documentation for Mastercard SecureCode™, Verified by Visa™, JCB J/Secure™, American Express SafeKey™, or Diners Club ProtectBuy™.
Data may consist of the characters a-z, A-Z
Information about payer authentication using 3-D Secure authentication version 2.
String
OPTIONAL
Reference number assigned to the issuer's Access Control Server (ACS) by EMV Co upon approval of the ACS.
This field corresponds to EMVCo field acsReferenceNumber.
Data can consist of any characters
String
OPTIONAL
A unique transaction identifier assigned by the Access Control Server to identify the 3DS transaction.
Data can consist of any characters
Enumeration
OPTIONAL
The EMV 3DS authentication scheme that was used to process the authentication request.
You must provide this field for co-branded card transactions that were authenticated outside MPGS using an external 3DS provider.
For example, for externally authenticated Mada co-branded transactions, you must provide either MADA, MASTERCARD or VISA to specify the 3DS directory server.
Value must be a member of the following list. The values are case sensitive.
AMEX
for American Express SafeKey EMV 3DS authentications
CARTE_BANCAIRE
for FAST'R by CB EMV 3DS authentications
DISCOVER
for Diners Club/Discover ProtectBuy EMV 3DS authentications
ITMX
for ITMX LSS EMV 3DS authentications
JCB
for JCB J/Secure EMV 3DS authentications
MADA
for mada secure EMV 3DS authentications
MASTERCARD
for Mastercard Identity Check EMV 3DS authentications
UNIONPAY
for UnionPay EMV 3DS authentications
VISA
for Visa Secure EMV 3DS authentications
JSON Text
OPTIONAL
Additional information returned by the scheme or issuer in the authentication response that must be included (together with the standard authentication details) when submitting the transaction for processing by the acquirer.
Data is valid Json Format
String
OPTIONAL
Reference number assigned to the Directory Server (DS) by EMV Co upon approval of the DS.
This field corresponds to EMVCo field dsReferenceNumber.
Data can consist of any characters
Alphanumeric + additional characters
OPTIONAL
The version of the EMV 3-D Secure protocol used to perform 3-D Secure authentication, in the format specified by EMVCo.
For example, 2.1.0
Data may consist of the characters 0-9, a-z, A-Z, '.'
Information provided by the 3-D Secure Software Development Kit (SDK) that is used by an app on the payer's device to enable 3-D Secure authentication of the payer to be performed in-app.
You must populate the fields in this parameter group when you authenticate the payer in-app using 3-D Secure authentication version 2.
String
OPTIONAL
A unique identifier for the app on the payer's device.
The 3-D Secure SDK generates this identifier each time the app is installed or updated.
This field corresponds to EMVCo field sdkAppID
Data can consist of any characters
String
OPTIONAL
Information about the payer's device collected and encrypted by the 3-D Secure SDK.
The data is a JSON Web Encryption (JWE) object in JSON format. When using the REST/JSON gateway API, express this as a JSON string (i.e. the embedded quotes will be escaped).
This field corresponds to EMVCo field sdkEncData
Data can consist of any characters
JSON Text
OPTIONAL
A public key generated by the 3-D Secure SDK.
This key is used to establish a secure session between the 3DS SDK and the issuer's Access Control Server (ACS) when the payer is required to be presented with an authentication challenge.
The key is a JSON Web Key (JWK) object in JSON format. When using the REST/JSON gateway API, express this as a JSON string (i.e the embedded quotes will be escaped).
This field corresponds to EMVCo field sdkEphemPubKey
Data is valid Json Format
Enumeration
OPTIONAL
The User Interface (UI) formats that the payer's device supports.
These are the formats that can be used to render the screens presented to the payer during an authentication challenge.
You only need to provide this value if you only support one of these formats.
This field corresponds to EMVCo data element sdkInterface in the field deviceRenderOptions.
Value must be a member of the following list. The values are case sensitive.
HTML
The device supports HTML format.
NATIVE
The device supports the UI format native to the payer's device.
String
OPTIONAL
An identifier of the vendor and version of the 3-D Secure SDK assigned by EMVCo.
This field corresponds to EMVCo field sdkReferenceNumber
Data can consist of any characters
Integer
OPTIONAL
The duration (in seconds) available to the payer to authenticate.
Will default to 900 if not provided. Note: The value will be rounded up to the nearest minute.
This field corresponds to EMVCo field sdkMaxTimeout
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
String
OPTIONAL
A unique identifier assigned by the 3-D Secure SDK for the transaction.
This field corresponds to EMVCo field sdkTransID
Data can consist of any characters
Comma separated enumeration
OPTIONAL
Indicates the UI types which the SDK supports for displaying authentication challenges within the app.
A comma separated list of the payer authentication methods that you will accept for this payment.
You only need to provide this value if all of these values are not supported.
Note: OTHER_HTML is only supported when authentication.3ds2.sdk.interface allows a HTML UI format.
This field corresponds to EMVCo data element sdkUiType in the field deviceRenderOptions.
Value must be one or more comma separated members of the following list. The values are case sensitive.
TEXT
The payer is asked to enter text into a field displayed on the UI. For example, ask the payer to enter a One Time Password sent to their registered mobile phone number.
SINGLE_SELECT
The payer is asked to select a single option from a number of presented options. For example, ask the payer if they want a One Time Password to be sent to either their email address or mobile phone number registered with their issuer.
MULTI_SELECT
The payer is asked to select multiple options from a number of presented options. For example, ask the payer to select valid responses to a question.
OUT_OF_BAND
The payer is presented with screens rendered by an out-of-band service during an authentication challenge, For example, the payer is asked to confirm the payment from their banking app.
OTHER_HTML
The payer is presented with an authentication challenge using other mechanisms supported in HTML but not in the native UI format. For example, the payer is asked to confirm an image presented on the screen.
String
OPTIONAL
A code indicating the reason for the transaction status returned in authentication.3ds2.transactionStatus.
Refer to the EMVCo specification for 3-D Secure.
Data can consist of any characters
Alpha
OPTIONAL
Indicates the result of payer authentication with the issuer.
This is the value returned in the transaction status field from the issuer's Access Control Server (ACS). For example, Y, N, U, A, R
Refer to the EMVCo specification for 3-D Secure.
Data may consist of the characters a-z, A-Z
Comma Separated Enumeration
OPTIONAL
A comma separated list of the payer authentication methods that you will accept for this payment.
You only need to provide a value if you want to restrict the authentication methods you will accept.
If you do not specify a value, then the gateway treats it as if you will accept all available authentication methods.
If you accept both 3DS2 and 3DS1, then the gateway will use 3-D Secure version 2 if supported by the issuer and fallback to use 3-D Secure version 1 if it is not.
Value must be one or more comma separated members of the following list. The values are case sensitive.
3DS1
3-D Secure Version 1
3DS2
3-D Secure Version 2
Decimal
OPTIONAL
The amount for which the payer authentication has been performed.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Enumeration
OPTIONAL
Indicates if you want the payer to be presented with an authentication challenge for this transaction.
You can use this to support local mandates or your risk tolerance. For example, you may prefer that a challenge is always performed when you store card details on file.
If you do not provide a value, the gateway will use NO_PREFERENCE. If there is no payer present (for example, recurring payments), then the gateway will ignore this field and use NO_CHALLENGE.
Note: 'challenge' means requiring the payer to take action to identify themselves, for example, entering a password.
Value must be a member of the following list. The values are case sensitive.
CHALLENGE_MANDATED
You require that the payer is presented with a challenge.
CHALLENGE_PREFERRED
You prefer that the payer is presented with a challenge.
NO_CHALLENGE
You prefer that the payer is not presented with a challenge.
NO_PREFERENCE
You do not have a preference. The issuer may present the payer with a challenge.
REQUEST_TRUSTED_MERCHANT_LISTING
You want the issuer to present the payer with a challenge and invite the payer to add you to the list of trusted merchant for this card. If the payer agrees, the response will contain authentication.psd2.trustedMerchantStatus=ON_LIST. This will allow you to request a trusted merchant exemption the next time you authenticate the payer for a payment with this card.
Enumeration
OPTIONAL
Indicates the channel in which the authentication request is being initiated.
Value must be a member of the following list. The values are case sensitive.
MERCHANT_REQUESTED
The merchant is requesting authentication of a cardholder without the payer being available for interaction (for example. as part of processing of a recurring payment).
PAYER_APP
Payer is interacting via an application on their device which uses an EMVCo-certified SDK.
PAYER_BROWSER
Payer is interacting via web browser (for example, with the merchant's ecommerce web-site).
String
OPTIONAL
Description of the goods being purchased.
If supported, this description will be displayed on the authentication UI presented to the payer.
Data can consist of any characters
Url
OPTIONAL
The URL to which the gateway will send the 3DS Method completion notification.
You only need to provide this value if you want to be notified on completion of the 3DS Method call.
If you do not specify a value, and if Method URL is supported for the transaction, then the gateway will handle the Method completion on behalf of you.
Ensure that this is a valid URL according to RFC 1738.
This parameter group is only applicable if you are subject to the Regulatory Technical Standards (RTS) requirements for Strong Customer Authentication (SCA) under the Payment Services Directive 2 (PSD2) regulations in the European Economic Area.
It provides details about SCA exemptions under PSD2.
Enumeration
OPTIONAL
Indicates why this payment qualifies for exemption from Strong Customer Authentication (SCA) under the Payment Services Directive 2 (PSD2).
Note:
- For recurring payments provide the RECURRING_PAYMENT value only if the amount is the same. If the amount varies, provide MERCHANT_INITIATED_TRANSACTION instead.
Value must be a member of the following list. The values are case sensitive.
AUTHENTICATION_OUTAGE
Allows the merchant to claim an exemption because authentication was not possible due to a technical outage.
AUTO
If either a LOW_RISK or LOW_VALUE_PAYMENT or TRUSTED_MERCHANT exemption applies to the transaction, it is automatically claimed by the gateway on behalf of the merchant.
LOW_RISK
Exemption is claimed because the acquirer has a low fraud rate.
LOW_VALUE_PAYMENT
Exemption is claimed as the amount is below 30 Euro.
MERCHANT_INITIATED_TRANSACTION
The transaction is excluded as it was initiated by the merchant based on an agreement with the payer. For example, a recurring payment (for a varied or fixed amount), installment payment, or account top-up. In these cases, the payer is not present and cannot participate in an authentication interaction. Merchant initiated transactions are only applicable to subsequent transactions on the order and are out of scope of the PSD2 RTS on Strong Customer Authentication (SCA). The payer must be authenticated during the first transaction that established the agreement.
NONE
An exemption is not claimed for this transaction. The merchant requires Strong Customer Authentication (SCA) be performed.
RECURRING_PAYMENT
The transaction is exempt as it was initiated by the merchant based on an agreement with the payer for a recurring payment for a fixed amount. This value is only applicable to subsequent transactions on the order. In this case, the payer is not present and cannot participate in an authentication interaction. The payer must be authenticated during the first transaction that established the agreement.
SCA_DELEGATION
The transaction is exempt as the issuer has delegated Strong Customer Authentication (SCA) using a compliant method to a third party. For example, the payer was subject to SCA when a card was enrolled with a wallet provider or SCA was delegated to the merchant.
SECURE_CORPORATE_PAYMENT
The transaction is exempt as it is a corporate or Business-to-Business (B2B) payment performed using dedicated payment processes and protocols that are not available to consumers and offer at least equivalent security levels.
TRUSTED_MERCHANT
The transaction is exempt because the payer has added you to the list of their trusted merchants (as maintained by the issuer).
Enumeration
OPTIONAL
Indicates the context in which payer authentication is being requested.
If you do not provide a value, the gateway will use PAYMENT_TRANSACTION as the default.
If you are authenticating the payer when establishing a payment agreement with your payer for a series of recurring, installment or unscheduled payments you must provide details about the agreement in the agreement parameter group in the AUTHENTICATE_PAYER request for this transaction.
Note:
- • If you set this value to ADD_CARD or MAINTAIN_CARD, then set order.amount to zero and order.currency to any currency you support.
- • If the authentication scheme that applies to the account does not support the purpose that you have requested, this call will return an authenticationStatus of AUTHENTICATION_NOT_SUPPORTED.
- • If you set this to REFRESH_AUTHENTICATION then when you perform the subsequent Authenticate Payer operation you must provide details of the original authentication, either by providing the authentication data explicitly via the fields customer.account.history.issuerAuthentication.acsTransactionId, customer.account.history.issuerAuthentication.authenticationToken, customer.account.history.issuerAuthentication.time and customer.account.history.issuerAuthentication.type, or by providing the gateway reference of the original authentication operation in customer.account.history.issuerAuthentication.transactionId.
- • If you set this value to AGREEMENT_CANCELLATION, you must provide the agreement.id and order.amount for which the agreement was registered in the AUTHENTICATE_PAYER request.
Value must be a member of the following list. The values are case sensitive.
ADD_CARD
Authentication performed before a payer's card is stored on file either directly by the merchant or using the gateway's tokenization feature. A payment is not being processed.
AGREEMENT_CANCELLATION
Authentication performed before cancelling the agreement.
MAINTAIN_CARD
Authentication performed before updating details of a payer's card stored on file either directly by the merchant or using the gateway's tokenization feature. A payment is not being processed.
PAYMENT_TRANSACTION
Authentication performed when of processing a card payment.
REFRESH_AUTHENTICATION
Authentication performed in order to obtain a new authentication token to replace one previously obtained for the order which is no longer valid (for example, because the order amount has changed in the time between originally performing authentication and submitting the financial transaction).
Url
OPTIONAL
The URL to which you want to redirect the payer after completing the payer authentication process.
This will be a URL on your website, with the URL encoded as defined in RFC3986. This means special characters such spaces, hyphens, etc must be encoded.
You must provide this URL, unless you are certain that there will be no interaction with the payer.
Ensure that this is a valid URL according to RFC 1738.
DateTime
OPTIONAL
Date and time of the payer authentication being performed.
An instant in time expressed in ISO8601 date + time format - "YYYY-MM-DDThh:mm:ss.SSSZ"
String
OPTIONAL
The transactionId you used for the Initiate Authentication operation.
Data can consist of any characters
Authorisation response fields for a standalone capture request.
Alphanumeric
OPTIONAL
The authentication token verification result code provided by the scheme.
For Discover ProtectBuy transactions this is known as CAVV (Cardholder Authentication Verification Value) result code.
Data may consist of the characters 0-9, a-z, A-Z
ASCII Text
OPTIONAL
The acquirer AVS response code generated by the card issuing institution.
Data consists of ASCII characters
String
OPTIONAL
Indicates the card level result returned by the issuer.
Data can consist of any characters
String
OPTIONAL
CSC Incorrect Indicator.
An indicator, provided by the Issuer in the authorization response, to identify the presence of an invalid card security code (CSC). If there is an error, the Issuer will respond with the 1-byte CSC Error Code (Y).
Data can consist of any characters
Alphanumeric
OPTIONAL
An Indicator, if a Card security code was provided for the Transaction, as returned by the acquirer.
Data may consist of the characters 0-9, a-z, A-Z
String
OPTIONAL
Indicates if the card used is a commercial card.
Data can consist of any characters
String
OPTIONAL
Indicates the type of commercial card as returned by the card issuer.
Data can consist of any characters
Digits
OPTIONAL
The local date, in MMDD format, in which the authorization was received from the acquirer, issuer or local terminal.
Data is a string that consists of the characters 0-9.
String
OPTIONAL
Indicates the code of the financial network that was used to process the transaction with the issuer.
Data can consist of any characters
Date
OPTIONAL
The date for the Authorization as returned by the scheme.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
String
OPTIONAL
Indicates the market or the industry associated with the payment.
For example, B may indicate "bill payment" depending on the acquirer.
Data can consist of any characters
String
OPTIONAL
Indicates the specific card information conditions for capture that are available when the card transaction occurs at point of service.
Data can consist of any characters
String
OPTIONAL
The POS Entry Mode provided to Discover (JCB (US Domestic only), and Diners) for the authorization.
Bytes 1-2: Discover (JCB (US Domestic only), and Diners) POS Entry Mode
Byte 3: Discover (JCB (US Domestic only), and Diners) Pin Entry Capability
Byte 4: RFU (Always zero)
Note: Only the first 3 bytes are required for settlement processing.
Data can consist of any characters
String
OPTIONAL
Identifies the type of Card Transaction sent to Card Acceptor.
Data can consist of any characters
String
OPTIONAL
The response code which indicates the status of the transaction.
Data can consist of any characters
String
OPTIONAL
The ACI (Authorization Characteristics Indicator) returned by the issuer.
Data can consist of any characters
Digits
OPTIONAL
The local time, in HHMMSS format, in which the authorization was received from the acquirer, issuer or local terminal.
Data is a string that consists of the characters 0-9.
Time Offset
OPTIONAL
The local time zone, in +hhmm or -hhmm format, in which the authorization was received from the acquirer, issuer or local terminal.
Data must comply with ISO 8601 UTC time offset format, +hhmm or -hhmm.
String
OPTIONAL
Indicates the magnetic stripe condition and the vulnerability for fraud in Discover Network Card Transactions.
Data can consist of any characters
String
OPTIONAL
The unique identifier for the transaction returned by the issuer.
Data can consist of any characters
Alphanumeric
OPTIONAL
The Transaction Integrity Class (TIC) is an indicator defined by the scheme to evaluate the safety and security of the transaction.
The indicator is only supported by some schemes and for all regions.
Data may consist of the characters 0-9, a-z, A-Z
String
OPTIONAL
The validation code returned by the issuer.
This value must be stored to be sent with the capture transaction.
Data can consist of any characters
Details of the payer's billing address.
The payer's billing address.
This data may be used to qualify for better interchange rates on corporate purchase card transactions.
String
OPTIONAL
The city portion of the address.
Data can consist of any characters
String
OPTIONAL
The name of the company associated with this address.
Data can consist of any characters
Upper case alphabetic text
OPTIONAL
The 3 letter ISO standard alpha country code of the address.
Data must consist of the characters A-Z
Alphanumeric + additional characters
OPTIONAL
The post code or zip code of the address.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
String
OPTIONAL
The state or province of the address.
Data can consist of any characters
String
OPTIONAL
The three character ISO 3166-2 country subdivision code for the state or province of the address.
Providing this field might improve your payer experience for 3-D Secure payer authentication.
Data can consist of any characters
String
OPTIONAL
The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Data can consist of any characters
String
OPTIONAL
The second line of the address (if provided).
Data can consist of any characters
Information used to manage interactions with the payment provider if you are offering your payment page on a website or are redirecting the payer's browser to the provider's website.
If you are offering your payment page in an app or are redirecting the payer to the provider's app, use the appPayment parameter group.
The payer's consent for different operations as captured by you.
For example, the consent can be for storing account details for recurring transactions or token generation, or for using account details while refunding a previous transaction etc.
Boolean
OPTIONAL
This indicates the payer's consent as recorded by the Merchant to store the account details in the gateway.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
String
OPTIONAL
The language that you prefer the payment provider to use for pages displayed to the payer.
You can provide either the two-letter primary language tag (for example, en, fr) or the two-letter primary language tag plus the region sub-tag (for example, en-US, fr-CA).
Data must be a language identifier or IETF language tag
Additional information you can provide to control the user interaction flow presented to the payer by Open Banking.
Boolean
OPTIONAL
Indicates during the checkout flow whether payer has provided consent for refund in order to store payer account details in the gateway.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
Enumeration
OPTIONAL
The type of transaction you want to create for this payment.For a successful Authorization transaction, you must submit a CAPTURE request to move the funds from the payer's account to your account.
Value must be a member of the following list. The values are case sensitive.
ACCOUNTSETUP
The transaction created in the gateway is an ACCOUNT SETUP transaction.
AUTHORIZE
The transaction created in the gateway is an AUTHORIZATION transaction.
PAY
The transaction created in the gateway is a PAYMENT transaction.
Additional information you can provide to control the user interaction flow presented to the payer by PayPal.
Enumeration
OPTIONAL
Indicates the action that PayPal displays to the payer prior to being redirected back to your website.
This field is only required when requesting a PayPal billing agreement.
Value must be a member of the following list. The values are case sensitive.
AGREE
After the payer has approved the billing agreement and their browser has been returned to your website, you will not process a payment against this billing agreement at that time.
AGREE_AND_PAY
After the payer has approved the billing agreement and their browser has been returned to your website, you will process a payment against this billing agreement.
Boolean
OPTIONAL
Indicates whether you want PayPal to display the shipping address to the payer on the PayPal website.
By default, the shipping address is displayed to the payer. For more detailed information about displaying the shipping address on the PayPal website, see PayPal Integration: Display/Override Shipping Address.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
Boolean
OPTIONAL
Indicates whether you want to allow the payer to change the shipping address for the payment on the PayPal website.
By default, the payer is allowed to change the shipping address. For more detailed information about the payer overriding the shipping address on the PayPal website, see PayPal Integration: Display/Override Shipping Address.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
Enumeration
OPTIONAL
Indicates where in the checkout flow you want the payer to commit to the payment - on the PayPal website or on your website after returning from the PayPal website.
By default this is set to CONFIRM_AT_PROVIDER.
Value must be a member of the following list. The values are case sensitive.
CONFIRM_AT_MERCHANT
The payer commits to the payment on your website.
CONFIRM_AT_PROVIDER
The payer commits to the payment on the PayPal website.
Url
OPTIONAL
The URL of your website to which you want the payer's browser to be redirected on completing the payment interaction at the payment provider's website.
The same return URL will be used by the gateway to redirect the payer's browser irrespective of the success or otherwise of the payment interaction. This field is not required if the payer is to be redirected to your app or if the browser payment provider's checkout flow is presented on a modal window on top of your payment page.
Ensure that this is a valid URL according to RFC 1738.
This parameter group captures all information that has been generated by the gateway or third party service provider and will be used by them to help provide the services to you.
String
OPTIONAL
The attribute name whose value is used by the gateway service or the third party service to identify the payer or their account or your account or any similar detail with them, and which facilitates them to offer their service to you.
Data can consist of any characters
String
OPTIONAL
The attribute name whose value is used by the gateway service or the third party service to identify the payer or their account or your account or any similar detail with them, and which facilitates them to offer their service to you.
Data can consist of any characters
Information about any constraints that apply to this transaction.
Specify constraints to ensure that the transaction conforms to predefined criteria. This is useful if your integration does not directly collect all the transaction values (e.g. a session-based integration or a checkout integration).
Information about the payment plan constraints which apply for this transaction.
Specify payment plan constraints to restrict the available payment plan options for this transaction.
Integer
OPTIONAL
The allowable number of deferral months for the payment plan.
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
Integer
OPTIONAL
The allowable number of installments for the payment plan.
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
String
OPTIONAL
The identifiers for the payment plans supported for this transaction.
If you wish to offer any payment plans to the payer, provide the plan identifiers in this field else pass it as empty.
See Payment Plans for the supported payment plans and their identifiers.
Data can consist of any characters
String
OPTIONAL
A transient identifier for the request, that can be used to match the response to the request.
The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.
Data can consist of any characters
Details about credit card bill payments.
The details about the person who is requesting that you pay the credit card bill.
The payment sender's address.
String
OPTIONAL
The city portion of the address.
Data can consist of any characters
Upper case alphabetic text
OPTIONAL
The 3 letter ISO standard alpha country code of the address.
Data must consist of the characters A-Z
Alphanumeric + additional characters
OPTIONAL
The post code or zip code of the address.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
String
OPTIONAL
The three character ISO 3166-2 country subdivision code for the state or province of the address.
Data can consist of any characters
String
OPTIONAL
The first line of the street address.
Data can consist of any characters
Digits
OPTIONAL
Submit this field if the account identifier of the payment sender is a bank account number.
For a split payment where both a debit card and bank account were used, you must provide both the creditCardBillPayment.paymentSender.cardNumber and the creditCardBillPayment.paymentSender.bankAccountNumber field.
Data is a string that consists of the characters 0-9.
Digits
OPTIONAL
Submit this field if the account identifier of the payment sender is a debit card number.
For a split payment where both a debit card and bank account were used, you must provide both the creditCardBillPayment.paymentSender.cardNumber and the creditCardBillPayment.paymentSender.bankAccountNumber field.
Data is a string that consists of the characters 0-9.
String
OPTIONAL
The payment sender's first name.
Data can consist of any characters
String
OPTIONAL
The payment sender's last name.
Data can consist of any characters
Information associated with the customer's account.
Information about the customer's account with you
Information about how you authenticated the payer.
A record that ties together a customer's account on your website or application with a card which they use, using a service such as Mastercard Identity Check Express (IDCX).
By performing payer authentication for that card, and recording that against the secured login, it is possible to achieve a frictionless payer authentication flow for future transactions by showing that they have securely logged in to the merchant using that account. To demonstrate this, you should provide the customer.account.authentication.data, customer.account.authentication.method and customer.account.authentication.time fields.
Enumeration
OPTIONAL
Used to perform additional behaviour relating to the association between the customer account and their card.
Value must be a member of the following list. The values are case sensitive.
AUTHENTICATION
You are submitting a payment or non-payment Authentication request with evidence of strong customer authentication you have already performed to be validated against a previously created record, in order to obtain frictionless authentication for the payer.
REGISTRATION
You are submitting evidence of strong customer authentication performed by your website or application using a suitable, certified authentication mechanism, in order to record an association between this customer login and the 3DS authenticated cardholder.
String
OPTIONAL
The data returned by an authentication service that you used to authenticate the customer when they logged on to your site/service.
For example, a FIDO token provided by a federated identity provider.
Data can consist of any characters
Enumeration
OPTIONAL
The method you used to authenticate the payer.
Value must be a member of the following list. The values are case sensitive.
CUSTOMER_ACCOUNT_LOGIN
The merchant authenticated the payer using a credential system (for example,password) that they manage.
FEDERATED_IDENTITY_LOGIN
The merchant authenticated the payer using a federated identity management service such as Google or Facebook
FIDO_AUTHENTICATION
The merchant authenticated the payer using hardware, mobile, or biometrics based authentication that is compliant with FIDO Alliance specifications.
ISSUER_ACCOUNT_LOGIN
The merchant authenticated the payer using a credential system for example, password) managed by the issuer.
NONE
The merchant did not authenticate the payer.
THIRD_PARTY_ACCOUNT_LOGIN
The merchant authenticated the payer using a credential system managed by a third party.
DateTime
OPTIONAL
The data and time you authenticated the payer using the method specified in customer.account.authentication.method.
You must provide the authentication time if you authenticated the payer.
An instant in time expressed in ISO8601 date + time format - "YYYY-MM-DDThh:mm:ss.SSSZ"
Information about the payer's historical activity related to their customer account with you.
Integer
OPTIONAL
Number of times the account holder has tried to add or change their card over the last 24 hours.
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
Integer
OPTIONAL
The number of transactions (successful and abandoned) that have been requested in the last year for all payment methods stored against this customer account.
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
Date
OPTIONAL
The date the payer created an account with you.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
Information about the payer authentication performed for a previous transaction with you.
String
OPTIONAL
The unique transaction identifier used by the issuer's Access Control Server (ACS) to identify the transaction.
If you are processing a recurring payment, then provide the transaction acsTransactionId for the transaction where the payer was authenticated.
Data can consist of any characters
Base64
OPTIONAL
The authentication token obtained as the result of a previous authentication request.
Data is Base64 encoded
DateTime
OPTIONAL
The date and time the payer was authenticated for the prior transaction.
If you are processing a recurring payment, then provide the time and date for the transaction where the payer was authenticated.
An instant in time expressed in ISO8601 date + time format - "YYYY-MM-DDThh:mm:ss.SSSZ"
String
OPTIONAL
The transaction ID of a previous Authenticate Payer request on the order, which the gateway can retrieve and use instead of you providing the data explicitly in the customer.account.history.issuerAuthentication.authenticationToken, customer.account.history.issuerAuthentication.type and customer.account.history.issuerAuthentication.time and customer.account.history.issuerAuthentication.acsTransactionId fields.
You should provide this if you are performing an authentication request to obtain a new authentication token to replace one which is no longer valid due to age or details such as the amount of the transaction having changed.
Data can consist of any characters
Enumeration
OPTIONAL
The method used to authenticate the payer for a prior transaction with you.
Value must be a member of the following list. The values are case sensitive.
3DS_FRICTIONLESS
3DS authentication was performed without payer interaction.
3DS_CHALLENGE
3DS authentication was performed and the payer was challenged for additional information.
ADDRESS_VERIFICATION
The issuer verifed the billing address provided by the payer. 3DS authentication was not used.
OTHER
The issuer verifed the payer using another method.
Date
OPTIONAL
The date the payer's account with you was last updated.
For example, they changed address details or changed card details.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
Date
OPTIONAL
The date the payer last changed the password for their account with you.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
Integer
OPTIONAL
The number of transactions (successful and abandoned) that have been requested in the last 24 hours for all payment methods stored against this customer account.
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
Date
OPTIONAL
The date you first shipped goods to the payer's shipping address provided in the shipping.address parameter group.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
Boolean
OPTIONAL
Have you experienced suspicious or fraudulent activity on the account in the past.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
String
OPTIONAL
Your identifier for the payer's account with you.
This should be an immutable identifier, rather than the customer's name, email or such data that could be changed by the customer.
Data can consist of any characters
Date
OPTIONAL
The payer's date of birth.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
Email
OPTIONAL
The email address of the customer.
The field format restriction ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
String
OPTIONAL
The payer's first name.
Data can consist of any characters
Identification of the payer.
This information is used to identify the sender in account funding transactions.
Upper case alphabetic text
OPTIONAL
The ISO 3166 three-letter country code of the issuer of the identification.
Data must consist of the characters A-Z
Enumeration
OPTIONAL
The type of identification provided for the customer.
Value must be a member of the following list. The values are case sensitive.
ALIEN_REGISTRATION_NUMBER
The customer's identification type is an alien registration number issued by U.S. Citizenship and Immigration Services (USCIS) to immigrants who apply to live in the United States.
BUSINESS_TAX_ID
The customer's identification type is a business tax id which is assigned to the business entity by the tax department.
COMPANY_REGISTRATION_NUMBER
The customer's identification type is company registration number which is issued to the company at the time of its incorporation.
CUSTOMER_IDENTIFICATION
The customer's identification type is an unspecified form of customer identification through which the customer can identified and verified.
DATE_OF_BIRTH
The customer's identification type is date of birth.
DRIVERS_LICENSE
The customer's identification type is a driving license.
EMAIL
The customer's identification type is an email address.
GOVERNMENT_ISSUED
The customer's identification type is government issued.
INDIVIDUAL_TAX_ID
The customer's identification type is an individual tax id which is assigned to the individual by the tax department.
LAW_ENFORCEMENT_IDENTIFICATION
The customer's identification type is a law enforcement identification.
MILITARY_IDENTIFICATION
The customer's identification type is a military identification which is issued by the department of defense and military.
NATIONAL_IDENTIFICATION_CARD
The customer's identification type is a national identification card issued by the customer's country.
OTHER
The customer's identification type cannot be classified using any of the other categories. This is the default value.
PASSPORT
The customer's identification type is a passport.
PHONE_NUMBER
The customer's identification type is a phone number.
PROXY_IDENTIFICATION
The customer's identification type is proxy identification.
SOCIAL_SECURITY_NUMBER
The customer's identification type is a social security number issued by Social Security Administration (SSA) to U.S. citizens, permanent residents and eligible non-immigrant workers in United States.
TRAVEL_IDENTIFICATION
The customer's identification type is travel document other than a passport.
String
OPTIONAL
The identification value/number for the type of identification provided in customer.identification.type.
Data can consist of any characters
String
OPTIONAL
The payer's last or surname.
Data can consist of any characters
String
OPTIONAL
The payer's middle name.
Data can consist of any characters
Telephone Number
OPTIONAL
The payer's mobile phone or cell phone number in ITU-T E123 format, for example +1 607 1234 5678
The number consists of:
- '+'
- country code (1, 2 or 3 digits)
- 'space'
- national number ( which may embed single spaces characters for readability).
Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)
String
OPTIONAL
An identifier for the payer assigned by a government authority.
For example, in Mexico this could be the CURP (Clave Única de Registro de Población), RFC (Registro Federal del Contribuyente), or INE (Instituto Nacional Electoral) number. In Brazil this could be the CPF (Cadastro de Pessoas Físicas) or CNPJ (Cadastro Nacional de Pessoas Jurídicas).
Data can consist of any characters
Telephone Number
OPTIONAL
The payer's phone number in ITU-T E123 format, for example +1 607 1234 456
The number consists of:
- '+'
- country code (1, 2 or 3 digits)
- 'space'
- national number ( which may embed single spaces characters for readability).
Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)
String
OPTIONAL
The tax registration identifier of the customer.
Data can consist of any characters
Information about the device used by the payer for this transaction.
String
OPTIONAL
The telephone number captured by ANI (Automatic Number Identification) when the customer calls to place the order.
Data can consist of any characters
String
OPTIONAL
The 2 digit ANI information identifier provided by the telephone company to indicate the call type, for example, cellular (61-63), toll free (24,25), etc.
Data can consist of any characters
String
OPTIONAL
The User-Agent header of the browser the customer used to place the order.For example, MOZILLA/4.0 (COMPATIBLE; MSIE 5.0; WINDOWS 95)
You must provide a value in this field if you are performing 3-D Secure authentication of the payer and set authentication.channel = PAYER_BROWSER.
Data can consist of any characters
Detailed information about the payer's browser.
If you are using 3-D Secure authentication to authenticate the payer, then this information is used by the issuer's Access Control Server (ACS) to identify the capabilities of the payers browser so that it can render content appropriately when authenticating the payer.
You must provide values for fields in this parameter group if you are performing 3-D Secure authentication of the payer and set authentication.channel = PAYER_BROWSER.
Enumeration
OPTIONAL
Dimensions of the challenge window (in width x height in pixels) displayed to the payer during 3D-Secure authentication.
This must be provided for authentication operations where authentication.channel is PAYER_BROWSER.
Value must be a member of the following list. The values are case sensitive.
250_X_400
390_X_400
500_X_600
600_X_400
FULL_SCREEN
String
OPTIONAL
The content of the Accept request-header field as sent from the payer's browser.
This is used to determine which content types are supported by the browser.
This must be provided for authentication operations where authentication.channel is PAYER_BROWSER.
Data can consist of any characters
Integer
OPTIONAL
The bit depth (in bits per pixel) of the color palette for displaying images.
You obtain this value from the screen.colorDepth property of the payer's browser.
This must be provided for authentication operations where authentication.channel is PAYER_BROWSER.
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
Boolean
OPTIONAL
Indicates whether or not the payer's browser supports Java.
You obtain this value from the navigator.javaEnabled property of the payer's browser
This must be provided for authentication operations where authentication.channel is PAYER_BROWSER.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
Boolean
OPTIONAL
Indicates whether or not the payer's browser supports JavaScript.
You can determine this by setting the relevant value in a form to false, and then attempting to update it to true using JavaScript.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
String
OPTIONAL
The language supported for the payer's browser as defined in IETF BCP47.
You obtain this value from the navigator.language property of the payer's browser.
This must be provided for authentication operations where authentication.channel is PAYER_BROWSER.
Data can consist of any characters
Integer
OPTIONAL
The total height of the payer's browser screen in pixels.
You obtain this value from the screen.height property of the payer's browser
This must be provided for authentication operations where authentication.channel is PAYER_BROWSER.
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
Integer
OPTIONAL
The total width of the payer's browser screen in pixels.
You obtain this value from the screen.width property of the payer's browser
This must be provided for authentication operations where authentication.channel is PAYER_BROWSER.
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
Browser Time Zone Offset
OPTIONAL
Time difference between UTC time and the Cardholder browser local time, in minutes.
The time zone offset is the difference, in minutes, between UTC and local time. Note that this means that the offset is positive if the local time zone is behind UTC and negative if it is ahead. For example, for time zone UTC+10:00 (Australian Eastern Standard Time, Vladivostok Time, Chamorro Standard Time), -600 would be presented.
This must be provided for authentication operations where authentication.channel is PAYER_BROWSER.
Browser time zone offset between -840 to +840.
String
OPTIONAL
Information collected about a remote computing device for the purpose of providing a unique identifier for the device.
For example, session ID, blackbox ID.
Data can consist of any characters
String
OPTIONAL
The name of the server to which the customer is connected.
Data can consist of any characters
String
OPTIONAL
The IP address of the device used by the payer, in IPv4 nnn.nnn.nnn.nnn format.
You can provide the IP address in IPv6 format as defined in RFC4291.
IPv6 address will only be used in EMV 3DS authentication. Supplied IPv6 address will not be used for any other purposes.
Data can consist of any characters
String
OPTIONAL
The mobile phone manufacturer's identifier for the model of the mobile device used to initiate the payment.
Data can consist of any characters
Enumeration
OPTIONAL
The type of disbursement used for this transaction.
If your Merchant Category Code is 7995 (Gambling Transactions) and you are paying out gaming winnings, set the value to GAMING_WINNINGS. If your Merchant Category Code is 6536 (MoneySend Intracountry) and you are paying a credit card bill, set the value to CREDIT_CARD_BILL_PAYMENT and provide the payment sender details.
Value must be a member of the following list. The values are case sensitive.
CREDIT_CARD_BILL_PAYMENT
Indicates that you are paying a credit card bill.
GAMING_WINNINGS
Indicates that you are paying out gaming winnings to a payer.
Additional information about the external token repository you are configured with.
These fields are MANDATORY for MerchantLink merchants and must not contain sensitive data.
String
OPTIONAL
Provide the site code required to save card details against a token.
For example: '{"siteCode":"BNE"}'.
Data can consist of any characters
Enumeration
OPTIONAL
The interface through which the transaction is submitted to the gateway.
Value must be a member of the following list. The values are case sensitive.
AUTO
The transaction was automatically generated by the gateway. For example, a Capture transaction for Auto-Capture or an order reversal transaction for risk rejected orders.
BATCH
The transaction was submitted as part of a merchant batch. Batches can either be uploaded via Batch or via Merchant Administration.
CHECKOUT_VIA_PAYMENT_LINK
The transaction was created via checkout. The payer was redirected to checkout by clicking on a payment link.
CHECKOUT_VIA_WEBSITE
The transaction was created via checkout. The payer was redirected from your website to checkout.
MERCHANT_ADMINISTRATION
The transaction was initiated in Merchant Administration.
MERCHANT_MANAGER
The transaction was initiated in Merchant Manager.
SERVICE_PROVIDER_API
The transaction was reported by an acquirer or alternate payment provider.
WEB_SERVICES_API
The transaction was submitted via Web Services API.
String
OPTIONAL
The person who initiated this transaction.
This field is automatically populated by the gateway if the transaction was created via Merchant Administration (gatewayEntryPoint=MERCHANT_ADMINISTRATION) or Merchant Manager (MERCHANT_MANAGER). In this case this is the name that the person used to log in to Merchant Administration or Merchant Manager respectively.
Data can consist of any characters
Information about the API operations that you will use to submit the financial transaction requests.
Enumeration
OPTIONAL
Indicates operation that payer wish to perform to submit the financial transaction requests.
Value must be a member of the following list. The values are case sensitive.
AUTHORIZE
Request for the Payment Configuration interaction to check AUTHORIZE transaction for the payment is supported by the acquirer.
NONE
Payment Configuration interaction will collect the payment details from the payer and securely store them against the Payment Options Inquiry. No operation will be performed after the payer interaction.
PURCHASE
Request for the Payment Configuration interaction to check PURCHASE transaction for the payment is supported by the acquirer.
VERIFY
Request for the Payment Options Inquiry to verify the payer's account.Request for the Payment Options Inquiry interaction to check Verify transaction for the payment is supported by the acquirer.
String
OPTIONAL
Tyro might have configured your merchant profile to support several lines of business.
Each line of business can have different payment parameters, such as bank account, supported cards or such.
For example, lineOfBusiness = TICKET_SALES can have a different bank account from lineOfBusiness = MERCHANDISING. One line of business on your profile might be "null". To use that, do not provide the lineOfBusiness field.
Data can consist of any characters except space
String
OPTIONAL
A language identifier or IETF language tag to control the language of the payment interaction with the payer (e.g. en_US, es, fr-CA).
By default, the language is determined from your configuration. Supply a value for this field only if you wish to override the default behavior. If the language you specify is not supported by the gateway, the payment is displayed in the best matching language.
See Dynamic Currency Conversion for more detail.
Data must be a language identifier or IETF language tag
Alphanumeric + additional characters
REQUIRED
The unique identifier issued to you by your payment provider.
This identifier can be up to 12 characters in length.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
Information about the order associated with this transaction.
Boolean
OPTIONAL
Indicates whether you will accept a payment less than order.amount, e.g. when using a gift card.
If not set or set to FALSE, and the full amount is not available, the transaction will be rejected.
Unless you have been advised by tyro that the gateway supports partial approvals for your acquirer, you can ignore this field.
If the gateway supports partial approvals for your acquirer you must set this field to TRUE else the transaction is rejected by the gateway.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
Decimal
OPTIONAL
The total amount for the order. This is the net amount plus any merchant charge amounts.If you provide any sub-total amounts, then the sum of these amounts (order.itemAmount, order.taxAmount, order.shippingAndHandlingAmount, order.cashbackAmount, order.gratuityAmount, order.merchantCharge.amount and order.dutyAmount), minus the order.discountAmount must equal the net amount.
The value of this field in the response is zero if payer funds are not transferred.
Either Amount or netAmount must be provided
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Boolean
OPTIONAL
Set this flag if the transaction is a manual cash disbursement transaction, i.e. cash is disbursed upon the acceptance of a card by a financial institution teller.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
Decimal
OPTIONAL
The amount the payer has chosen to receive as cash in addition to the amount they are paying for the goods or services they are purchasing from you.
The cash back amount is included in the total amount of the order you provide in order.amount.
This field corresponds to EMV tag 9F03
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Enumeration
OPTIONAL
Indicates if you expect to capture the full order amount for which you are requesting authorization.
If you do not provide a value for order.certainty the default configured for you by tyro will be used. The value provided in the response shows the value the gateway sent to the acquirer
Value must be a member of the following list. The values are case sensitive.
ESTIMATED
The amount authorized is an estimate of the amount that will be captured. It is possible that the amount captured will be less, or might not be captured at all.
FINAL
The full authorized amount is expected to be captured within the mandated time. The order will only be cancelled in exceptional circumstances (for example, the payer cancelled their purchase).
Upper case alphabetic text
OPTIONAL
The currency of the order expressed as an ISO 4217 alpha code, e.g. USD.
Data must consist of the characters A-Z
String
OPTIONAL
Information about this order that is of interest to you.
For example order.custom.X, where 'X' is defined by you and must be less than 100 characters from the set A-Z, a-z, 0-9. For example, order.custom.salesRegion. You can specify up to 50 such fields. They are not sent to acquirers.
Data can consist of any characters
String
OPTIONAL
A note from the payer about this order.
Data can consist of any characters
Date
OPTIONAL
The date the payer placed the order.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd.
ASCII Text
OPTIONAL
The payer's own reference for the order.
This reference may assist the payer to identify the order in their system. For example, a purchase order number, project identifier, or cost center.
Data consists of ASCII characters
String
OPTIONAL
Short textual description of the contents of the order.
Data can consist of any characters
Information about a price reduction you have applied to the order.
For example, you may apply discounts for trade, employees, bulk purchase, or a sales promotion.
Decimal
OPTIONAL
The total amount of the discount you have applied to the order.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
OPTIONAL
The code you use to identify the reason for the discount.
Data can consist of any characters
String
OPTIONAL
A description of your reason for the discount.
Data can consist of any characters
Decimal
OPTIONAL
The duty amount (also known as customs tax, tariff or dues) for the order.
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
Digits
OPTIONAL
This field only applies if you intend to receive the payer's funds in several Capture operations.
You must provide this value where you want the gateway to automatically reverse the outstanding Authorization amount you do not intend to capture. Note that this requires your merchant profile to be configured accordingly. Contact tyro if you are unsure about your configuration.
The field indicates the total number of Capture requests you intend to submit for an order. For example, if you intend to deliver the goods in two shipments and will capture part of the total authorized amount when you make each shipment, set the value of this field to 2.
If the value equals or drops below the actual number of successful Captures, then the gateway will prevent further Captures and void the outstanding Authorization amount (depending on your merchant profile configuration). If you are unsure of the number of Captures, set the value to 99, and to one on your last Capture.
If you do not provided a value for this field, but had previously provided one, the previous value is applied. For example, if you provide a value 2 on the first Capture for the order and then submit a second Capture without a value, the gateway assumes that the value is still 2.
Data is a number between 1 and 99 represented as a string.
Decimal
OPTIONAL
The amount the payer has chosen to provide as a gratuity or tip in addition to the amount they are paying for the goods or services they are purchasing from you.
The gratuity amount is included in the total amount of the order you provide in order.amount.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
OPTIONAL
A unique identifier for this order to distinguish it from any other order you create.
Use this identifier when referring to this order in subsequent transactions and in retrieval operations. This value must be unique for every order you create using your merchant profile.
Data can consist of any characters
Enumeration
OPTIONAL
This field is used to classify merchant initiated payments which are submitted in the context of certain industry practices.
Use this field to indicate the reason for that industry practice payment.
A merchant initiated industry practice transaction must also contain the 'scheme transaction Id' from the associated cardholder initiated transaction.
You can provide the referenceOrderId of the relevant cardholder initiated transaction and the gateway will include the 'scheme transaction Id' on the industry practice transaction. For example, when you submit a 'delayed charge', you should provide the referenceOrderId of the cardholder-initiated transaction that resulted in the delayed charge.
Alternatively, you can provide the 'scheme transaction Id' of the cardholder initiated transaction in the industry practice transaction using the field transaction.acquirer.traceId.
You must have obtained the payer's consent prior to submitting industry practice transactions.
Value must be a member of the following list. The values are case sensitive.
DELAYED_CHARGE
An additional payment processed in accordance with your terms and conditions after the original payment has been processed. For example, hotel mini bar charge after the payer has checked out or damage to a rental car.
NO_SHOW_PENALTY
A penalty charged in accordance with your charge cancellation policy the payer cancels or fails to show for the booking.
PARTIAL_SHIPMENT
A shipment where merchant decides to ship the goods from the same order in multiple shipments due to various reasons like goods availability, involvement of multiple suppliers for goods etc.
String
OPTIONAL
The invoice number you issued for this order.
Data can consist of any characters
Information about the items the payer purchases with the order.
String
OPTIONAL
The brand of the item.
For example, Dell.
Data can consist of any characters
String
OPTIONAL
Your category for the item.
Data can consist of any characters
String
OPTIONAL
Description for the item with information such as size, color, etc.
For example, 'Color:Red, Size:M'
Data can consist of any characters
Only use this parameter group to provide additional line item details required for a better interchange rate for Purchasing Cards, Business and/or Corporate Cards (Level 3).
Check with tyro if Level 3 data is supported for your acquirer.
JSON Text
OPTIONAL
Use this field to provide line item details that your acquirer requires you to provide.
Data must be provided in JSON format using the record name and field name (separated by a comma) to identify the value provided. Contact tyro for details about the supported fields including the field definitions.
Data is valid Json Format
Digits
OPTIONAL
A code describing a commodity or a group of commodities pertaining to goods classification.
Data is a number between 1 and 9999999999999999 represented as a string.
Information about the taxes per line item.
Decimal
OPTIONAL
The tax amount for the tax type defined in order.item[n].detail.tax[m].type for the item.
Note that the tax amount provided must reflect the tax amount applied before a discount was applied.
Data is a string that consists of the characters 0-9, '.' and '-' and represents a valid decimal number.
Decimal
OPTIONAL
The tax rate (percentage) applied to the item for the tax type defined in order.item[n].detail.tax[m].type.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
OPTIONAL
The tax type for which the amount specified under order.item[n].detail.tax[m].amount has been paid for this item.
The correct value as used by your acquirer may have to be provided. Contact tyro for details.
Data can consist of any characters
Decimal
OPTIONAL
The discount rate (percentage) applied to this item.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Decimal
OPTIONAL
The tax rate (percentage) of the tax charged for this item.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
OPTIONAL
The type of tax charged for this item.
The correct value as used by your acquirer may have to be provided. Contact tyro for details.
Data can consist of any characters
Digits
OPTIONAL
The United Nations Standard Products and Services Code (UNSPSC) for the item.
Data is a number between 1 and 9999999999999999 represented as a string.
Digits
OPTIONAL
The Universal Product Code (UPC) for the item.
Data is a number between 1 and 9999999999999999 represented as a string.
URI
OPTIONAL
The URL of the item image for display to the payer during the payment interaction.For best results, use images in JPEG or PNG formats.The recommended size is 144 pixels width and 144 pixels height.
The image will be cropped at this height and width.
Data must be an absolute URI conforming to the URI syntax published by IETF RFC 2396. The URI must be one of the following schemes : https
Enumeration
OPTIONAL
Provide the industry category to send this line item to your acquirer for specialized processing as industry data.
Such processing might have legal obligations, which are your responsibility. Do not provide an industry category, unless you are certain it applies to you, and is accepted by your acquirer.
We support the following industry standard processing:US health care processing using the IIAS standard.The supported values for this field are:HEALTHCARE_VISION, HEALTHCARE_DENTAL, HEALTHCARE_PRESCRIPTION, HEALTHCARE_OTHERWe formulate an IIAS message by summing the amounts of all the line items with the same industry category. The amount of a line item is computed as:(order.item.unitPrice + order.item.tax) * order.item.quantity
Value must be a member of the following list. The values are case sensitive.
HEALTHCARE_DENTAL
HEALTHCARE_OTHER
HEALTHCARE_PRESCRIPTION
HEALTHCARE_VISION
String
OPTIONAL
A short name describing the item.
Data can consist of any characters
Decimal
OPTIONAL
The quantity of the item.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number greater than zero.
String
OPTIONAL
The serial number of the item.
Data can consist of any characters
String
OPTIONAL
A list of serial numbers for this item.
Provide the serial numbers for the item that you have registered with the payment plan service provider for payment plan offers.
Data can consist of any characters
String
OPTIONAL
The SKU (Stock Keeping Unit) or the item identifier for this item.
Data can consist of any characters
Decimal
OPTIONAL
The discount amount applied to this item.
Data is a string that consists of the characters 0-9, '.' and '-' and represents a valid decimal number.
String
OPTIONAL
The unit of measure used for the item quantity.
The correct value as used by your acquirer may have to be provided. Contact tyro for details.
Data can consist of any characters
Decimal
OPTIONAL
The cost price for the item.
This amount is multiplied with the item quantity (item.quantity) to determine the total amount for this item (item.amount). This amount does not include the tax amount and/or discount amount applicable to this item.
Data is a string that consists of the characters 0-9, '.' and '-' and represents a valid decimal number.
Decimal
OPTIONAL
The tax amount for the item.
This amount is multiplied with the item quantity (item.quantity) to determine the total tax amount for this item.
Data is a string that consists of the characters 0-9, '.' and '-' and represents a valid decimal number.
Decimal
OPTIONAL
The total item amount for the order.
If you do not provide this value but provide line item data, then this amount is calculated as the sum of the item.quantity times the item.unitPrice for all the line items (total item amount).
If you provide both this value and line item data, then the order.itemAmount MUST equal the total item amount.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Information about the items the payer purchases with the order.
String
OPTIONAL
A short name describing the item.
Data can consist of any characters
Decimal
OPTIONAL
The quantity of the item.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number greater than zero.
String
OPTIONAL
The serial number of the item.
Data can consist of any characters
String
OPTIONAL
The SKU (Stock Keeping Unit) or the item identifier for this item.
Data can consist of any characters
Decimal
OPTIONAL
The cost price for the item.
This amount is multiplied with the item quantity (item.quantity) to determine the total amount for this item (item.amount). This amount does not include the tax amount and/or discount amount applicable to this item.
Data is a string that consists of the characters 0-9, '.' and '-' and represents a valid decimal number.
String
OPTIONAL
Your tax registration identifier provided by the Local/State/Province tax authority.
If you are a Canadian merchant, use this field to provide your Tax Registration ID for paying Provincial Sales Tax (PST).
Data can consist of any characters
Use this parameter group to provide additional information if you are a marketplace.You are considered a marketplace if you operate an electronic commerce website or mobile application that brings together payers and retailers and you are selling the goods or services on behalf of the retailer.In this case, the card schemes may require you to register with them as a marketplace and assign you a Marketplace ID.
You should provide this identifier to tyro so that the gateway can automatically include it in all transaction messages to your acquirer.
Enumeration
OPTIONAL
Provide information about the location of the retailers for goods or services included in this order.Where a retailer is located in a country different from your country, they are considered a foreign retailer, otherwise they are considered a domestic retailer.
Value must be a member of the following list. The values are case sensitive.
DOMESTIC_ONLY
The order only contains items from domestic retailers.
FOREIGN_AND_DOMESTIC
The order contains items from both foreign and domestic retailers.
FOREIGN_ONLY
The order only contains items from foreign retailers.
Digits
OPTIONAL
A 4-digit code used to classify your business by the type of goods or services it offers.
This is also known as the Merchant Category Code (MCC).
You only need to provide the MCC if you want to override the default value configured for your acquirer link.The value you provide must match one of those configured by tyro.
Data is a string that consists of the characters 0-9.
Information about additional fees that you are charging the payer for processing the payment for this order, for example, a surcharge.
Decimal
OPTIONAL
The amount of the additional fee that you are charging the payer.
If you provide a charge amount, you must include it in the total amount for the order.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Enumeration
OPTIONAL
The type of the additional fee that you are charging the payer.
Value must be a member of the following list. The values are case sensitive.
SURCHARGE
A fee that covers your cost of accepting accepting a payment method.
Digits
OPTIONAL
The code that represents a partnership agreement, between you and the issuer.
Data is a string that consists of the characters 0-9.
Decimal
OPTIONAL
The amount payable for the order before merchant charge amount is applied.
If you specify a net amount the gateway will calculate the merchant charge amount for you based on the charge type (order.merchantCharge.type) provided in the request. Alternatively, you can specify the merchant charge amount (order.merchantCharge.amount) yourself.
Either Amount or netAmount must be provided
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Url
OPTIONAL
The URL to which the gateway will send Webhook notifications when an order is created or updated.
To receive notifications at this URL, you must enable Webhook notifications in Merchant Administration. Ensure the URL is HTTPS
Ensure that this is a valid URL according to RFC 1738.
String
OPTIONAL
Your identifier for the part of your organization that is responsible for the order.
You might provide this data when you want to track the accountability for the order. For example, store number, sales region, branch, or profit center
Data can consist of any characters
Enumeration
OPTIONAL
Indicates the purchase of specific types of goods or services.
You must provide a value if your Merchant Category Code (MCC) is one of the following:
6051 (Quasi Cash – Merchant or Non-Financial Institutions – Foreign Currency, Non-Fiat Currency) and this transaction is for the purchase of cryptocurrency. Set the value to CRYPTOCURRENCY.
6211 (Securities – Brokers/Dealers) and this transaction is for the purchase of high-risk securities. Set the value to HIGH_RISK_SECURITIES.
6012 (Merchandise and Services—Customer Financial Institutions) or 6051 (Non-Financial Institutions – Foreign Currency, Non-Fiat Currency) and this transaction is for debt repayment. Set the value to DEBT_REPAYMENT.
If the transaction pulls money from an account for the purpose of crediting another account you must set purchase type to ACCOUNT_FUNDING.
You may set purchase type to OTHER for any other type of payment.
Value must be a member of the following list. The values are case sensitive.
ACCOUNT_FUNDING
The transaction pulls money from an account for the purpose of crediting another account. You may be required to provide additional details about the account funding transaction in the accountFunding parameter group.
CRYPTOCURRENCY
The transaction is for the purchase of a cryptocurrency.
DEBT_REPAYMENT
You may be required to provide additional details about the debt repayment in the debtRepayment parameter group.
HIGH_RISK_SECURITIES
The transaction is for the purchase of high-risk securities.
OTHER
Use this value if the purchase type for the transaction does not fit in any of the other categories.
String
OPTIONAL
The identifier of the order.
For example, a shopping cart number, an order number, or an invoice number.
Data can consist of any characters
String
OPTIONAL
The name of the person who requested the goods or services.
Data can consist of any characters
Information about reward points earned using a card enrolled in a rewards program that are being redeemed as full or part payment for this order.
Decimal
OPTIONAL
The amount that the payer has chosen to pay by redeeming reward points earned using a card enrolled in a rewards program for full or part payment for this purchase.
The reward amount is included in the total amount of the order you provide in order.amount.You must provide this value if the rewards program supports a payer-nominated amount (availableBalance.reward.payerNominatedAmount returned from the Balance Inquiry operation has a value of 'true').
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Alphanumeric + additional characters
OPTIONAL
An identifier generated by the gateway when you have requested the balance available for a credit or debit card.
The presence of this field indicates that rewards are to be redeemed.The gateway will use the details stored against this identifier when authorizing the payment with your acquirer.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '%', '.', '='
Decimal
OPTIONAL
The total shipping and handling amount for the order, including taxes on the shipping and/or handling.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Decimal
OPTIONAL
The tax amount levied on the shipping and handling amount for the order.
This amount is included in the shipping and handling amount provided in field order.shippingAndHandlingAmount.
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
Decimal
OPTIONAL
The tax rate applied to the shipping and handling amount for the order to determine the shipping and handling tax amount.
For a tax rate of 2.5% provide 0.025.
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
Contact information provided by you for printing on payer's account statements.
Descriptor address of the merchant.
String
OPTIONAL
The city portion of the address.
Data can consist of any characters
String
OPTIONAL
The name of the company associated with this address.
Data can consist of any characters
Upper case alphabetic text
OPTIONAL
The 3 letter ISO standard alpha country code of the address.
Data must consist of the characters A-Z
Alphanumeric + additional characters
OPTIONAL
The post code or zip code of the address.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
String
OPTIONAL
The state or province code of the address.
For an address in the United States provide the 2-letter ISO 3166-2 state code. For US military bases provide one of AE, AA, AP.
For an address in Canada provide the 2-letter ISO 3166-2 province code.
Data can consist of any characters
String
OPTIONAL
The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Data can consist of any characters
String
OPTIONAL
The second line of the address (if provided).
Data can consist of any characters
String
OPTIONAL
Descriptor name of the merchant.
Data can consist of any characters
String
OPTIONAL
Descriptor phone number of the merchant's business.
Data can consist of any characters
Url
OPTIONAL
The URL of the merchant's descriptor website.
Ensure that this is a valid URL according to RFC 1738.
Provide these parameters if you are a payment aggregator or facilitator and process payments on behalf of other merchants.
These merchants are referred to as your sub-merchants.
The sub-merchant's details you provide may be displayed on the payer's cardholder statement.
Note that your acquirer may require you to register with the card scheme(s) before allowing you to submit sub-merchant details with a transaction.
This data must be on the initial transaction of an order, subsequent transactions with sub-merchant will be rejected.
Note: If you are requesting payer authentication using 3-D Secure Version 2 then you must provide values for order.subMerchant.address.country and order.subMerchant.bankIndustryCode.
The sub-merchant's address.
String
OPTIONAL
The city portion of the address.
Data can consist of any characters
String
OPTIONAL
The name of the company associated with this address.
Data can consist of any characters
Upper case alphabetic text
OPTIONAL
The 3 letter ISO standard alpha country code of the address.
Data must consist of the characters A-Z
Alphanumeric + additional characters
OPTIONAL
The post code or zip code of the address.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
String
OPTIONAL
The state or province code of the address.
For an address in the United States provide the 2-letter ISO 3166-2 state code. For US military bases provide one of AE, AA, AP.
For an address in Canada provide the 2-letter ISO 3166-2 province code.
Data can consist of any characters
String
OPTIONAL
The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Data can consist of any characters
String
OPTIONAL
The second line of the address (if provided).
Data can consist of any characters
Information about the sub-merchant's registration to use a payer authentication protocol.
For example, using 3-D Secure authentication.
Information about the sub-merchant's registration to use 3-D Secure authentication version 2.
These details are used to identify the sub-merchant to the card scheme's directory server.
String
OPTIONAL
The unique identifier assigned to the merchant by the card scheme directory server when the merchant registered to use 3-D Secure authentication version 2 with their acquirer.
For American Express and UnionPay if it is provided it will be used otherwise it will be generated by the gateway. This identifier should not be provided for other supported authentication schemes, as it will be generated by the gateway.
Data can consist of any characters
String
OPTIONAL
The unique name assigned to the merchant by the card scheme directory server when the merchant registered to use 3-D Secure authentication version 2 with their acquirer.
For American Express and UnionPay if it is provided it will be used otherwise it will be generated by the gateway. This name should not be provided for other supported authentication schemes, as it will be generated by the gateway.
Data can consist of any characters
Enumeration
OPTIONAL
The protocol used for payer authentication.
Value must be a member of the following list. The values are case sensitive.
AMEX_SAFEKEY
American Express SafeKey EMV 3DS authentication
DINERS_PROTECTBUY
Diners ProtectBuy EMV 3DS authentication
FASTR_BY_CB
Carte Bancaire FAST'R by CB using EMV 3DS authentication
JCB_JSECURE
JCB J/Secure using EMV 3DS authentication
UNIONPAY
UnionPay EMV 3DS authentication
VERIFIED_BY_VISA
Visa Verified by Visa EMV 3DS authentication
Digits
OPTIONAL
Code used by acquirer to describe the business or industry the sub-merchant operates in.
You must provide a value if you want the gateway to perform 3-D Secure Version 2 authentication of the payer.
Data is a string that consists of the characters 0-9.
Telephone Number
OPTIONAL
Only provide this field if you have received a notification from the scheme that either you or the sub-merchant has a high number of disputes.
In this case, provide a phone number that payers can use to contact the sub-merchant in case of a dispute. Where applicable, the issuer may display this phone number on the cardholder statement. The phone number must be provided in ITU-T E123 format.
Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)
Email
OPTIONAL
The sub-merchant's email address.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
Upper case alphabetic text
OPTIONAL
Only provide this field if the sub merchant is a government owned or controlled merchant.
A sub merchant is considered a government owned or controlled entity (government controlled merchant) if 50% or more of the sub merchant is owned by the government. Provide the ISO 3166 three-letter country code of the government country where this differs from the sub merchant's physical location country.
Data must consist of the characters A-Z
Alphanumeric + additional characters
OPTIONAL
Your identifier for the sub-merchant.
You can use this identifier in searches and reports in the gateway.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '.'
String
OPTIONAL
If the sub merchant is a marketplace, provide the marketplace ID assigned to them by Visa.
A sub merchant is considered a marketplace if they operate a platform (online commerce website or mobile application) where retailers can sell goods and services.
Data can consist of any characters
String
OPTIONAL
The sub-merchant's phone number
Data can consist of any characters
String
OPTIONAL
The legal name of the sub-merchant.
Data can consist of any characters
String
OPTIONAL
The trading name of the sub-merchant, also known as doing business as (DBA), operating as or trading as.
For MasterCard transactions the name must not exceed 21 characters. For American Express transactions the name must not exceed 27 characters (or 36 characters including the aggregator name). The trading name may be displayed on the payer's cardholder statement. Therefore if you need to shorten it, use an abbreviation that will be meaningful to the payer when displayed on their statement.
Data can consist of any characters
Url
OPTIONAL
The URL of the sub-merchant's website.
Ensure that this is a valid URL according to RFC 1738.
Information about orders for items not yet available (pre-order) or for items previously purchased (reorder).
Boolean
OPTIONAL
Indicates that the purchase includes merchandise with a future availability or release date.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
Date
OPTIONAL
The date that preordered items are expected to be available.
Provide this field if the payer is ordering items before you have them available for purchase.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
Boolean
OPTIONAL
Indicates that the purchase includes merchandise that the payer has previously ordered.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
Use this parameter group to provide a breakdown of tax types, amount per tax type, and rate per tax type included in order.taxAmount.
Decimal
OPTIONAL
The tax amount included in this order for the tax type.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Decimal
OPTIONAL
The tax rate (percentage) used to determine the tax amount included in this order for the tax type.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
OPTIONAL
The type of tax included in the order amount.
The correct value as used by your acquirer may have to be provided. Contact tyro for details.
Data can consist of any characters
Decimal
OPTIONAL
The total tax amount for the order.
If you do not provide this value but provide line item data, then this amount is calculated as the sum of the item.quantity times the item.unitTaxAmount for all the line items (total tax amount).
If you provide both this value and line item data, then the order.taxAmount MUST equal the total tax amount.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
OPTIONAL
Your tax registration identifier provided by the Federal/National tax authority (for example, federal tax identification number, ABN).
If you are a Canadian merchant, use this field to provide your Tax Registration ID for paying Harmonized Sales Tax (HST) or Goods and Services Tax (GST) collected by the Canada Revenue Agency.
Data can consist of any characters
Enumeration
OPTIONAL
Indicates your tax status for this order.
Value must be a member of the following list. The values are case sensitive.
EXEMPT
Indicates that you are exempt from tax.
NOT_EXEMPT
Indicates that you are not exempt from tax.
NOT_PROVIDED
Indicates that you are not providing information about being exempt from tax.
Information relevant for Transaction Filtering.
Allows you to provide the Address Verification Service (AVS) Response Code Transaction Filtering rules to be applied to the transactions for this order.
If provided, these rules override the AVS Response Code Transaction Filtering rules you have configured in Merchant Administration.
Enumeration
OPTIONAL
The action to be performed for the Address Verification Service (AVS) Response Code.
Value must be a member of the following list. The values are case sensitive.
NO_ACTION
No action should be taken by the gateway.
REJECT
The gateway must reject the transaction.
REVIEW
The gateway must mark this transaction as requiring a review.
Enumeration
OPTIONAL
The Address Verification Service (AVS) Response Code for which you are defining the rule.
Value must be a member of the following list. The values are case sensitive.
ADDRESS_MATCH
Street address matched
ADDRESS_ZIP_MATCH
Street address and zip/postcode were matched
NAME_ADDRESS_MATCH
Card holder name and street address matched
NAME_MATCH
Card holder name matched
NAME_ZIP_MATCH
Card holder name and zip/postcode matched
NOT_AVAILABLE
No data available from issuer or AVS data not supported for transaction
NOT_REQUESTED
AVS not requested
NOT_VERIFIED
AVS could not be verified for an international transaction
NO_MATCH
No match
SERVICE_NOT_AVAILABLE_RETRY
Issuer system is unavailable. Retry can be attempted
SERVICE_NOT_SUPPORTED
Service currently not supported by acquirer or merchant
ZIP_MATCH
Zip/postcode matched. Street address not matched
Information about payments that transfer money to another store of value, such as a gift card or gaming chips.
Enumeration
OPTIONAL
The type of value store to which money is being transferred.
The default value is NOT_A_TRANSFER.
Value must be a member of the following list. The values are case sensitive.
ACCOUNT_FUNDING
Payment to add funds to the payer's account with the merchant. These funds can be used for future purchases.
NOT_A_TRANSFER
This payment is not for the purpose of transferring money to another store of value. It is a payment for goods or services.
PREPAID_LOAD
Payment to add funds to a prepaid card or gift card.
QUASI_CASH_TRANSACTION
Payment for items that are directly convertible to cash. For example, money orders, casino gaming chips, or traveller's checks.
Decimal
OPTIONAL
The amount of money being transferred, in units of order.valueTransfer.currency.
The default value is order.amount
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Upper case alphabetic text
OPTIONAL
The currency of the store.
If the money is being transferred to multiple currencies, then use the currency of the highest transferred value.
The default value is order.currency.
Data must consist of the characters A-Z
Integer
OPTIONAL
The number of prepaid or gift card being purchased.
The default value is one when you set order.valueTransfer.accountType = PREPAID_LOAD. For all other values of order.valueTransfer.accountType the default is zero.
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
String
OPTIONAL
The wallet indicator as returned by the wallet provider.
Data can consist of any characters
Enumeration
OPTIONAL
Details about the source of the payment details used for digital payment methods.
Provide this value when you process payments for:
- • Device payment methods such as Apple Pay, Android Pay, Samsung Pay, or Google Pay.
- • Digital wallets such as Secure Remote Commerce (Click to Pay).
Value must be a member of the following list. The values are case sensitive.
APPLE_PAY
Apple Pay mobile wallet provider.
CHASE_PAY
Chase Pay wallet provider.
GOOGLE_PAY
Google Pay mobile wallet provider.
SAMSUNG_PAY
Samsung Pay mobile wallet provider.
SECURE_REMOTE_COMMERCE
Secure Remote Commerce (SRC) wallet provider.
Enumeration
OPTIONAL
The payment method the payer wishes to use to pay for this order.
Value must be a member of the following list. The values are case sensitive.
ACH
BROWSER_PAYMENT
CARD
PAYCONIQ
PAYPAL
PAYSAFECARD
PAYU
String
OPTIONAL
This is the reference to an order previously submitted by you to the gateway.
It is applicable to the following scenarios.
Tokenization requests:
Identifier for the order which will be used to generate a gateway token. The gateway will attempt tokenization of payment credentials linked to the order ID.
The order identifier provided in this field must be linked to a successfully processed order which has card (FPAN / DPAN) as the payment method.
When providing this field, you must not provide card details in the sourceOfFunds.provided.card parameter group.
Payment transactions:
When submitting:
- an industry practice payment, this is the reference to the initial cardholder-initiated transaction.
- a resubmission transaction, this is the reference to the order which is being resubmitted.
Data can consist of any characters
Information relevant to risk assessment.
Enumeration
OPTIONAL
The risk rules you wish to bypass when performing risk assessment for an order.
Value must be a member of the following list. The values are case sensitive.
ALL
String
OPTIONAL
Additional data passed to third-party risk assessment providers.
This field is only relevant if you use a third-party risk assessment provider, and you have agreed with them the values to provide (maximum 100 characters in a field name from the set A-Z, a-z, 0-9, maximum 4kB in length of values across all custom risk fields). An example might be:
Field: risk.custom.headOfficeLocation
Value: London UK
Data can consist of any characters
Details about the recipient of the payment and the destination account for the payment.
Your acquirer may require you to provide these details if you are a financial institution (Merchant Category Code 6012) submitting a transaction for a person paying off outstanding debts. Otherwise, do not provide these data elements.
String
OPTIONAL
The account identifier for the payment recipient's account.
For payments into a card account provide the card number. For payments into other accounts (for example a bank account) provide the account number. The value provided will be returned masked in the response.
Data can consist of any characters
Date
OPTIONAL
The date of birth of the primary payment recipient in yyyy-mm-dd format.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
String
OPTIONAL
Last name of the primary payment recipient.
Data can consist of any characters
String
OPTIONAL
Postcode of the primary payment recipient.
Data can consist of any characters
Enumeration
OPTIONAL
The mode used to create a gateway token and obtain a scheme token from the token service provider.
You only need to specify the scheme token provisioning mode if you want to override the default value configured for your token repository.
You can refer to the schemeToken.status field in the response for the status of the scheme token stored against the gateway token.
Value must be a member of the following list. The values are case sensitive.
ASYNCHRONOUS
The gateway token is generated and immediately returned to you in the response. The network token will then be requested and, if successful, linked to the gateway token.
ATTEMPT_SYNCHRONOUS
The gateway token is generated and the network token is immediately requested. If successful, it is linked to the gateway token, and you receive the response. If unsuccessful, the gateway token is still returned, with the network token generation re-tried again later.
SYNCHRONOUS
The network token is requested immediately. If successful, the gateway token is returned in the response. Otherwise, an error response is returned and the gateway token is not created.
ASCII Text
REQUIRED
The identifier of the payment session.
Data consists of ASCII characters
ASCII Text
OPTIONAL
Use this field to implement optimistic locking of the session content.
Do this if you make business decisions based on data from the session and wish to ensure that the same data is being used for the request operation.
To use optimistic locking, record session.version when you make your decisions, and then pass that value in session.version when you submit your request operation to the gateway.
If session.version provided by you does not match that stored against the session, the gateway will reject the operation with error.cause=INVALID_REQUEST.
See Making Business Decisions Based on Session Content.
Data consists of ASCII characters
Shipping information for this order.
The address to which this order will be shipped.
String
OPTIONAL
The city portion of the address.
Data can consist of any characters
String
OPTIONAL
The name of the company associated with this address.
Data can consist of any characters
Upper case alphabetic text
OPTIONAL
The 3 letter ISO standard alpha country code of the address.
Data must consist of the characters A-Z
Alphanumeric + additional characters
OPTIONAL
The post code or zip code of the address.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
Enumeration
OPTIONAL
Indicates whether the shipping address provided is the same as the payer's billing address.
Provide this value if you are not providing the full shipping and billing addresses, but you can affirm that they are the same or different.
The default value for this field is:
SAME - if the shipping and billing address are supplied, and all fields are the same (ignoring non-alphanumerics).
DIFFERENT - if the shipping and billing address are supplied, and at least one field is different (ignoring non-alphanumerics).
UNKNOWN - either shipping address or billing address is absent.
Value must be a member of the following list. The values are case sensitive.
DIFFERENT
The shipping and billing addresses are different.
SAME
The shipping and billing addresses are the same.
UNKNOWN
It is not known if the shipping and billing addresses are the same.
Enumeration
OPTIONAL
How you obtained the shipping address.
Value must be a member of the following list. The values are case sensitive.
ADDRESS_ON_FILE
Order shipped to an address that you have on file.
NEW_ADDRESS
Order shipped to an address provided by the payer for this transaction.
String
OPTIONAL
The state or province of the address.
Data can consist of any characters
String
OPTIONAL
The three character ISO 3166-2 country subdivision code for the state or province of the address.
Providing this field might improve your payer experience for 3-D Secure payer authentication.
Data can consist of any characters
String
OPTIONAL
The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Data can consist of any characters
String
OPTIONAL
The second line of the address (if provided).
Data can consist of any characters
Details of the contact person at the address the goods will be shipped to.
Email
OPTIONAL
The contact person's email address.
The field format restriction ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
String
OPTIONAL
The first name of the person to whom the order is being shipped.
Data can consist of any characters
String
OPTIONAL
The last name or surname of the person to whom the order is being shipped.
Data can consist of any characters
Telephone Number
OPTIONAL
The contact person's mobile phone or cell phone number in ITU-T E123 format, for example +1 607 1234 5678
The number consists of:
- '+'
- country code (1, 2 or 3 digits)
- 'space'
- national number ( which may embed single spaces characters for readability).
Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)
Telephone Number
OPTIONAL
The contact person's phone number in ITU-T E123 format, for example +1 607 1234 456
The number consists of:
- '+'
- country code (1, 2 or 3 digits)
- 'space'
- national number ( which may embed single spaces characters for readability).
Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)
Enumeration
OPTIONAL
Indicates whether the supplied name for the recipient of shipping matches the cardholder name.
Provide this value if you are not providing the full name or cardholder name, but you can affirm that they are the same or different.
Default value is UNKNOWN
Value must be a member of the following list. The values are case sensitive.
DIFFERENT
The shipping and billing addresses are different.
SAME
The shipping and billing addresses are the same.
UNKNOWN
It is not known if the shipping and billing addresses are the same.
Enumeration
OPTIONAL
The shipping method used for delivery of this order.
Value must be a member of the following list. The values are case sensitive.
ELECTRONIC
Electronic delivery.
GROUND
Ground (4 or more days).
NOT_SHIPPED
Order for goods that are not shipped (for example, travel and event tickets)
OVERNIGHT
Overnight (next day).
PICKUP
Shipped to a local store for pick up.
PRIORITY
Priority (2-3 days).
SAME_DAY
Same day.
Alphanumeric + additional characters
OPTIONAL
The post code or zip code of the address the order is shipped from.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
The details describing the source of the funds to be used.
For card payments these may be represented by combining one or more of the following: explicitly provided card details, a session identifier which the gateway will use to look up the card details and/or a card token. Precedence rules will be applied in that explicitly provided card details will override session card details which will override card token details. Each of these may represent partial card details, however the combination must result in a full and complete set of card details. See Using Multiple Sources of Card Details for examples.
Information about the source of funds when it is directly provided (as opposed to via a token or session).
For browser payments, the source of funds details are usually collected from the payer on the payment provider's website and provided to you when you retrieve the transaction details (for a successful transaction). However, for some payment types (such as giropay), you must collect the information from the payer and supply it here.
Details as shown on the card.
Enumeration
OPTIONAL
You can provide this field for card types that have a savings/checking option, such as Maestro cards.
If you do not provide a value, we will use the acquirer's default. You can use paymentTypes.card.cardTypes in the 'Retrieve Payment Options' operation response to determine the card type.
Value must be a member of the following list. The values are case sensitive.
CHECKING
SAVINGS
Details about the card that you have sourced using digital payment methods.
Use this parameter group when you have sourced payment details using:
- Device payment methods such as Apple Pay, Android Pay, Samsung Pay, or Google Pay.
- Digital wallets such as Secure Remote Commerce (Click to Pay).
- Card scheme tokens. This applies when you have tokenized the payer's card number using a card scheme tokenization service such as Mastercard Digital Enablement Service (MDES).
Enumeration
OPTIONAL
The format of the cryptogram provided for the digital payment.Use this field for:
- • Device payments: provide the cryptogram format when you decrypt the payment token and provide the payment details (including the online payment cryptogram) in the transaction request.
This field does not apply to Card Scheme token payments.
Value must be a member of the following list. The values are case sensitive.
3DSECURE
The payment data keys for the online payment cryptogram are provided using the 3-D Secure format.
EMV
The payment data keys for the online payment cryptogram are provided using the EMV format.
Digits
OPTIONAL
The Electronic Commerce Indicator generated for payments made using a device payment method.
You source this field directly from the decrypted payment token.
This field is not applicable for payments using digital wallets or card scheme tokens.
Data is a string that consists of the characters 0-9.
Base64
OPTIONAL
A cryptogram used to authenticate the transaction.Use this field for:
- • Device payments: source this field directly from the decrypted payment token.
- • Card scheme tokens: source this field directly from the decrypted transaction credentials.
Data is Base64 encoded
String
OPTIONAL
This is the payment token that you received from the device's payment SDK.
For example:
For Apple Pay - this is the PKPaymentToken.paymentData value.
For Google - this is PaymentMethodToken.getToken().
Note 1: The gateway API considers this value to be a string, NOT JSON itself. Therefore when using the JSON gateway API, this field will typically look like:
"sourceOfFunds": {
"provided": {
"card": {
"devicePayment": {
"paymentToken": "{\"data\":\"869ss19ew ....
Note 2: The gateway will ignore the currency and amount information in the payment token, and will instead use the values passed on the amount and currency fields. For normal usage, you should populate those fields with the exact same values as you got from the SDK.
Data can consist of any characters
String
OPTIONAL
This field only applies to transactions that originate from an EMV capable terminal.
It contains selected EMV fields as provided by the terminal.
For the list of field tags to include (if provided by the terminal), see Card Present Payments. Requests with any other tags are rejected by the gateway.
Some of the tags represent data that can occur on explicit fields in this API. You can submit the value either in this field, or in both places. For example, the PAN can be presented as EMV tag 5A in this field, or included both the sourceOfFunds.provided.card.number API field and in EMV tag 5A in this field.
If you specify the EMV tag only, we can populate the explicit field in the API. Fields where this is supported have the text "This field corresponds to EMV tag <tag name>" in their field descriptions.
If you specify both places, there will be no population of the explicit field or validation that the data matches.
The API response will not contain PCI sensitive fields.
Data can consist of any characters
Expiry date, as shown on the card.
Digits
OPTIONAL
Month, as shown on the card.
Months are numbered January=1, through to December=12.
Data is a number between 1 and 12 represented as a string.
Digits
OPTIONAL
Year, as shown on the card.
The Common Era year is 2000 plus this value.
Data is a string that consists of the characters 0-9.
Masked digits
OPTIONAL
The Funding Primary Account Number (FPAN) of the payer's account in 6.4 masking format, for example, 000000xxxxxx0000.
You should use this value for display on confirmation or receipt pages presented to the payer.
RequestNormally you do not need to populate this field, as the gateway will populate this field in the session, and populate it into the payment request when you submit the payment using the session. You would only provide this value, if you had access to FPAN information that was not available to the gateway. On responses, the gateway populates it with a form that the payer would recognize (also explained in more detail below).
Retrieve session response
The gateway always populates this field with its best understanding of the masked FPAN.If you are showing PAN data from the session to the payer, then use this field rather than sourceOfFunds.provided.card.number from the session. This is because this field contains a PAN that the payer will recognize whereas sourceOfFunds.provided.card.number could contain a scheme token, or device PAN which the payer will not recognize. After the payment is processed, the gateway will populate the sourceOfFunds.provided.card.number in the payment response with its best understanding of the masked FPAN. You can show this value to the payer after the payment is complete. This logic also applies to the maskedFpanExpiry field.
Data is a string that consists of the characters 0-9, plus 'x' for masking
Expiry date, The expiry date of the Funding Primary Account Number (FPAN) in sourceOfFunds.provided.card.maskedFpan.
Digits
OPTIONAL
The expiration month for the Funding Primary Account Number (FPAN).
Months are numbered January=1, through to December=12.
Data is a number between 1 and 12 represented as a string.
Digits
OPTIONAL
The expiration year for the Funding Primary Account Number (FPAN).
The Common Era year is 2000 plus this value.
Data is a string that consists of the characters 0-9.
If the payer chose to pay using a mobile device you must provide details from the wallet in this parameter group.
Use this parameter group when accepting payments from mobile wallet providers such as Apple Pay, Android Pay or Samsung Pay.
Cryptogram data for mobile wallet payments provided in 3DSecure format.
Digits
OPTIONAL
The Electronic Commerce Indicator generated for the mobile wallet payment.
It indicates the level of security and authentication of the transaction.
Data is a string that consists of the characters 0-9.
Base64
OPTIONAL
The unique transaction cryptogram generated for the mobile wallet payment.
This will be in Base64 format for MasterCard and Visa transactions and binary format for American Express transactions.
Data is Base64 encoded
Enumeration
OPTIONAL
The format of the cryptogram provided for the device payment.
You must provide the cryptogram format when you decrypt the payment token and provide the payment details (including the online payment cryptogram) in the transaction request.
Value must be a member of the following list. The values are case sensitive.
3DSECURE
The payment data keys for the online payment cryptogram are provided using the 3-D Secure format.
EMV
The payment data keys for the online payment cryptogram are provided using the EMV format.
String
OPTIONAL
The cardholder's name as printed on the card.
Data can consist of any characters
Digits
OPTIONAL
Credit card number as printed on the card.
Data is a string that consists of the characters 0-9.
This holds the PAN in the case where it is encrypted by the terminal using DUKPT key exchange.
Digits
OPTIONAL
The BIN of the card.
If you provide this, the gateway will check that the decrypted PAN has these leading six digits. If the check fails, the gateway will reject the transaction.
If you do not provided this, the gateway will not perform this check.
Data is a string that consists of the characters 0-9.
String
OPTIONAL
The P2PE encryption state as determined by the terminal.
INVALID means the terminal detected some form of error in the encryption process. The gateway will decline transactions with INVALID encryption state. This field may be omitted when the value is VALID.
Data can consist of any characters
Hex
OPTIONAL
The initialization vector supplied by the terminal to seed the encryption of this payload.
Omit this value if the terminal is not using an initialization vector to seed encryption.
Data is hexadecimal encoded
Hex
OPTIONAL
The DUKPT key serial number supplied by the terminal.
Data is hexadecimal encoded
Hex
OPTIONAL
The DUKPT encrypted payload supplied by the terminal.
Data is hexadecimal encoded
Digits
OPTIONAL
The first 10 digits of the card number, as printed on the card.
Data is a string that consists of the characters 0-9.
Digits
OPTIONAL
Card verification code, as printed on the back or front of the card or as provided for a card scheme token.
Data is a string that consists of the characters 0-9.
Digits
OPTIONAL
A number used to differentiate between cards with the same Primary Account Number (PAN).
This field corresponds to EMV tag 5F34
Data is a number between 0 and 999 represented as a string.
Enumeration
OPTIONAL
This field only applies if you collect card details from your payer, store them, and either you or your payer use the stored credentials for subsequent payments.
Refer to Credential on File, Cardholder and Merchant-initiated Transactions for details.
Value must be a member of the following list. The values are case sensitive.
NOT_STORED
Set this value if you are not storing the card details provided by the payer for this transaction. The gateway sets this value by default, if you are submitting a payer-initiated transaction. You must not use this value when submitting merchant-initiated transactions.
STORED
Set this value if you have previously stored the card details provided by the payer and are now using these stored details. The gateway sets this value by default, if you are submitting a merchant-initiated transaction.
TO_BE_STORED
Set this value if this is the first transaction using these card details and you intend to store the card details if the transaction is successful.
Additional details related to a eps-Überweisung browser payment.
Alpha
OPTIONAL
The country where the payer has their bank account.
Provide the ISO 3166 alpha-3 country code for this country.
Data may consist of the characters a-z, A-Z
String
OPTIONAL
The name of the bank account holder for the payer's bank account.
Data can consist of any characters
Additional details related to a Klarna Pay Later payment.
Upper case alphabetic text
OPTIONAL
The country where the payer has their bank account.
Provide the ISO 3166 alpha-3 country code for this country.
Data must consist of the characters A-Z
Additional details related to a Klarna Pay Now payment.
Alpha
OPTIONAL
The country where the payer has their bank account.
Provide the ISO 3166 alpha-3 country code for this country.
Data may consist of the characters a-z, A-Z
Additional details related to Open Banking Bank Transfer.
String
OPTIONAL
Identifier of the payer's bank, also known as ASPSP (Account Servicing Payment Services Provider)
Data can consist of any characters
Additional details related to an OXXO browser payment.
When processing an OXXO payment you must also provide the payer's national identifier (customer.nationalId), your reference to the payer (customer.id) and the payer's date of birth (customer.dateOfBirth).
String
OPTIONAL
The name of the bank account holder for the payer's bank account.
Data can consist of any characters
Date
OPTIONAL
The date by which your payer has to make the payment.
Do not provide a due date for USD currency transactions.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
Additional details related to a PayU browser payment.
Alpha
OPTIONAL
The country where the payer has their bank account.
Provide the ISO 3166 alpha-3 country code for this country.
Data may consist of the characters a-z, A-Z
String
OPTIONAL
The name of the bank account holder for the payer's bank account.
Data can consist of any characters
Additional details related to a Payconiq payment.
Alpha
OPTIONAL
This is the country of the payer's payconiq account.
Provide the ISO 3166 alpha-3 country code for this country.
Data may consist of the characters a-z, A-Z
Information about the payer's PayPal account.
It is provided to you when the payer successfully makes a payment using PayPal or when you have established a billing agreement with the payer.
Email
OPTIONAL
The email address of the payer's PayPal account.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
String
OPTIONAL
The name of the account holder of the payer's PayPal account.
Data can consist of any characters
Details about the agreement you have established with the payer that allows you to bill the payer's PayPal account for goods or services.
Enumeration
OPTIONAL
Indicates the number of billing agreements between you and this payer.
Value must be a member of the following list. The values are case sensitive.
MULTIPLE
Indicates that you have multiple billing agreements with this payer. This means that a new agreement ID will be returned in response to each request.
SINGLE
Indicates that you have a single billing agreement with this payer. This means that the same agreement ID will be returned in response to each request.
String
OPTIONAL
Your description for the PayPal billing agreement.
This description is displayed to the payer when they are asked to approve the billing agreement.
Data can consist of any characters
String
OPTIONAL
An identifier provided by PayPal for the billing agreement.
Data can consist of any characters
String
OPTIONAL
Your name for the PayPal billing agreement.
Data can consist of any characters
String
OPTIONAL
The unique identifier for the payer assigned by PayPal.
Data can consist of any characters
Additional details related to a paysafecard browser payment.
Email
OPTIONAL
The mypaysafecard account email identifying the mypaysafecard account that will be refunded.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
Alpha
OPTIONAL
The country where the payer has their bank account.
Provide the ISO 3166 alpha-3 country code for this country.
Data may consist of the characters a-z, A-Z
Additional details related to Pay by Bank app payment.
Url
OPTIONAL
The URL of merchant app to which the payer is redirected from their mobile banking app.
Ensure that this is a valid URL according to RFC 1738.
Additional details related to a POLi browser payment.
String
OPTIONAL
The name of the bank account holder for the payer's bank account.
Data can consist of any characters
Additional details related to a Przelewy24 browser payment.
String
OPTIONAL
The name of the bank account holder for the payer's bank account.
Data can consist of any characters
Details about the payer's bank account used for a payment made using SEPA
String
OPTIONAL
The name of the bank account holder for the payer's bank account.
Data can consist of any characters
Alphanumeric
OPTIONAL
The international Business Identifier Code (BIC) for the payer's bank account.
Data may consist of the characters 0-9, a-z, A-Z
String
OPTIONAL
The International Bank Account Number (IBAN) for the payer's bank account.
By default, the bank account number will be returned in a masked format, for example, xxxxxx0000. If you wish to return unmasked bank account numbers, you must have the requisite permission, set responseControls.sensitiveData, and authenticate your call to the API using certificate authentication. Contact tyro for further information.
Data can consist of any characters
Additional details related to a Sofort (Klarna) payment.
Upper case alphabetic text
OPTIONAL
The country where the payer has their bank account.
Provide the ISO 3166 alpha-3 country code for this country.
Data must consist of the characters A-Z
Additional details related to a Trustly.
Alpha
OPTIONAL
The country where the payer has their bank account.
Provide the ISO 3166 alpha-3 country code for this country.
Data may consist of the characters a-z, A-Z
String
OPTIONAL
The name of the bank account holder for the payer's bank account.
Data can consist of any characters
Additional details related to a WeChat Pay browser payment.
String
OPTIONAL
The name of the account holder for the payer's WeChat Pay account.
Data can consist of any characters
ASCII Text
OPTIONAL
You only must provide this field if you want the gateway to retrieve a scheme token for card details that your payer has made available to you via their card issuer (i.e. push provisioning of scheme tokens).
Using the identifier provided by the issuer, the gateway will retrieve the scheme token details from the token service provider and store them against the gateway token.
When providing this field, you must not provide card details in the sourceOfFunds.provided.card parameter group, and you must set the sourceOfFunds.type field to CARD.
Data consists of ASCII characters
Alphanumeric
OPTIONAL
A gateway token that contains account identifier details.
The account identifier details stored against this token will be used to process the request.
If account identifier details are also contained in the request, or the request contains a session with account identifier details, these take precedence over the details stored against the token.
Data may consist of the characters 0-9, a-z, A-Z
Alphanumeric
OPTIONAL
The unique identifier assigned to you by the Token Service Provider that you requested a token from for this payment.
This field is mandatory for payments where the Chase Pay wallet was used.
Data may consist of the characters 0-9, a-z, A-Z
Enumeration
OPTIONAL
The payment method used for this payment.
If you are passing card data (in any form) on the API, then you need to set this value, and also provide the card details in the sourceOfFunds.provided.card group. In the case of digital wallets or device payment methods, you must also populate the order.walletProvider field.
If you are making a payment with a gateway token, then you can leave this field unset, and only populate the sourceOfFunds.token field. However you can set this to CARD if you want to overwrite or augment the token data with a card security code, expiry date, or cardholder name.
Value must be a member of the following list. The values are case sensitive.
ACH
The payer chose to pay using an electronic fund transfer, to be processed via the Automated Clearing House (ACH) Network. You must provide the payer's bank account details and information about the type of ACH payment under the sourceOfFunds.provided.ach parameter group.
ALIPAY
The payer selected the payment method Alipay.
BANCANET
The payer selected the payment method BancaNet Directo.
BANCONTACT
The payer selected the payment method Bancontact.
BLIK
The payer selected the payment method BLIK.
BOLETO_BANCARIO
The payer selected the payment method Boleto Bancario.
BROWSER_PAYMENT
The payer selected to pay using a browser payment. Refer to the sourceOfFunds.browserPayment parameter group for additional details.
CARD
Use this value for payments that obtained the card details either directly from the card, or from a POS terminal, or from a wallet, or through a device payment method.
DIRECT_DEBIT_CANADA
The payer chose to pay using Direct Debit in Canada, also known as pre-authorized bank debits (PADs). You must provide the payer's bank account details in the sourceOfFunds.provided.directDebitCanada parameter group.
EBT_CARD
Use this value for Electronic Benefits Transfer (EBT) card payments. The additional EBT data must also be provided in the sourceOfFunds.provided.ebt parameter group.
ENETS
The payer selected the payment method eNETS.
EPS_UEBERWEISUNG
The payer selected the payment method eps-Überweisung.
GIFT_CARD
The payer chose to pay using a gift card. The payer's gift card details must be provided under the sourceOfFunds.provided.giftCard parameter group.
GIROPAY
The payer selected the payment method giropay.
GRABPAY
The payer selected the payment method GrabPay.
IDEAL
The payer selected the payment method iDEAL.
KLARNA_FINANCING
The payer selected the payment method Klarna financing.
KLARNA_PAY_LATER
The payer selected the payment method Klarna Pay Later.
KLARNA_PAY_NOW
The payer selected the payment method Klarna Pay Now.
MERCADO_PAGO_CHECKOUT
The payer selected the payment method Mercado Pago Checkout.
MULTIBANCO
The payer selected the payment method Multibanco.
OPEN_BANKING_BANK_TRANSFER
The payer selected the payment method Open Banking Bank Transfer.
OXXO
The payer selected the payment method OXXO.
PAYCONIQ
The payer selected the payment method payconiq.
PAYPAL
The payer selected the payment method PayPal.
PAYSAFECARD
The payer selected the payment method paysafecard.
PAYU
The payer selected the payment method PayU.
PBBA
The payer selected the payment method Pay by Bank app
POLI
The payer selected the payment method POLi.
PRZELEWY24
The payer selected the payment method Przelewy24.
SCHEME_TOKEN
Use this value for payments using scheme tokens provided by Mastercard Digital Enablement Service (MDES), or Visa Token Service (VTS), or American Express Token Service (AETS).
SEPA
The payer selected the payment method SEPA.
SOFORT
The payer selected the payment method Sofortbanking.
TRUSTLY
The payer selected the payment method Trustly.
Provide these parameters if you are a payment aggregator or facilitator and process payments on behalf of other merchants.
These merchants are referred to as your sub merchants. The sub merchant's details you provide may be displayed on the payer's cardholder statement. The gateway will use separate token repositories for each of your sub merchants
Alphanumeric + additional characters
OPTIONAL
Your identifier for the sub-merchant.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '.'
Alphanumeric
OPTIONAL
The token you supply that you wish to create or update.
You can only supply this value when creating a token if your token repository is configured to support merchant-supplied tokens.
On response, the format of the token depends on the token generation strategy configured for your repository. See Tokenization for more details.
Data may consist of the characters 0-9, a-z, A-Z
Information about this transaction.
Additional information to be passed to acquirer.
String
OPTIONAL
Additional information requested by the acquirer which cannot be passed using other available data fields.
This field must not contain sensitive data.
Data can consist of any characters, but sensitive data will be rejected
String
OPTIONAL
The unique identifier that allows the issuer to link related transactions.
Typically the gateway takes care of submitting this identifier to the issuer on your behalf. However, you must submit this identifier if you have processed the payer-initiated transaction (also called CIT) for the payment agreement outside the gateway or you are submitting a Refund where the Authorization or Payment has been performed outside the gateway.
For a Mastercard transaction this identifier must contain the scheme issued transaction identifier, network code and network date, and is also known as the Trace ID. For a Visa or American Express transaction this identifier matches the scheme issued transaction identifier, also known as Transaction Identifier or TID. Refer to the scheme's documentation for more details.
Payment in a Series
You must provide the information returned in the Authorization/Payment/Verification response for the last payer-initiated transaction in the series (CIT).
Refund
You must provide the information returned in the Authorization/Payment response for the payment for which you are issuing a refund.
Resubmission
For resubmission transactions, the gateway will include the scheme transaction identifier from the failed transaction.
However, you may use this field to directly provide the scheme transaction identifier to be used on the resubmission in certain scenarios:
- Original failed transaction was processed outside the gateway.
- Multiple failed authorizations exist on the order and the resubmission needs to refer to a failed transaction which is not the latest.
Data can consist of any characters, but sensitive data will be rejected
String
OPTIONAL
This is the value provided to the acquirer to identify the order.
Ideally this will be the order.id, however if that value cannot be used directly, it will be transformed by the gateway to a unique value that the acquirer will accept. If that behavior is not suitable, you can directly provide the value in this field and it will be passed to the acquirer. You then take responsibility for its correctness. (Note: contact your payment provider to see if this is supported for your acquirer).
Data can consist of any characters, but sensitive data will be rejected
Decimal
OPTIONAL
Transaction Amount.
Expressed as a decimal number in the units of the currency. For example 12.34 in USD is the amount 12 dollars and 34 cents.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Comma separated enumeration
OPTIONAL
The action you want the gateway to take if you submit a capture amount that is different from the outstanding authorization amount for the order.
You only need to provide a value if you want to restrict the action taken and understand the relevant scheme rules.
The default value for this field is INCREMENT. In this case, the gateway will automatically submit an update authorization request to the acquirer if the requested capture amount exceeds the outstanding authorized amount. If the update was successfully authorized, the gateway then attempts the capture.
Set this value to NO_ACTION to prevent the gateway performing any authorization adjustments.
Note: You might need tyro to enable these capabilities on your gateway merchant profile.
Value must be one or more comma separated members of the following list. The values are case sensitive.
INCREMENT
Increase the authorized amount to match the total capture amount.
NO_ACTION
Do not perform any authorization adjustments.
Alphanumeric
OPTIONAL
Value generated by the issuing bank in response to a proposal to transfer funds.
Data may consist of the characters 0-9, a-z, A-Z
Additional information the gateway requires to initiate a BancaNet browser payment.
String
OPTIONAL
The payment reference for the payment.
The format depends on your BancaNet Directo account (Servicio Electrónico de Pagos or Concentración de Fondos).
Data can consist of any characters
Date
OPTIONAL
The date by when the payer should make the payment.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
String
OPTIONAL
The reason for the payment, for example, 'Pago de tarjeta', which is displayed to the payer on the BancaNet website.
Data can consist of any characters
Upper case alphabetic text
OPTIONAL
The currency of the transaction expressed as an ISO 4217 alpha code, e.g. USD.
Data must consist of the characters A-Z
Boolean
OPTIONAL
Indicates that you were not able to submit the Authorization (or Payment) transaction at the time it was completed with the cardholder due to a connectivity, system issue, or other limitations and have deferred submitting it until your system was back online.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
Decimal
OPTIONAL
The total amount deducted from the transaction amount that would normally apply.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Decimal
OPTIONAL
The duty amount (also known as customs tax, tariff or dues) for the transaction.
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
String
OPTIONAL
Unique identifier for this transaction to distinguish it from any other transaction on the order.
An order can have transactions representing:
- Movement of money. For example, payments and refunds.
- Validations. For example, account verification or 3-D Secure authentication of the payer.
- Undoing other transactions. For example, voiding a payment transaction.
- Chargebacks.
- Fees from tyro.
If you attempt an operation and it fails (eg you try to PAY on a card with no funds), then you need a new id for each retry.
Data can consist of any characters
Information about the items the payer purchases with the order.
String
OPTIONAL
The brand of the item.
For example, Dell.
Data can consist of any characters
String
OPTIONAL
Your category for the item.
Data can consist of any characters
String
OPTIONAL
Description for the item with information such as size, color, etc.
For example, 'Color:Red, Size:M'
Data can consist of any characters
Only use this parameter group to provide additional line item details required for a better interchange rate for Purchasing Cards, Business and/or Corporate Cards (Level 3).
Check with tyro if Level 3 data is supported for your acquirer.
JSON Text
OPTIONAL
Use this field to provide line item details that your acquirer requires you to provide.
Data must be provided in JSON format using the record name and field name (separated by a comma) to identify the value provided. Contact tyro for details about the supported fields including the field definitions.
Data is valid Json Format
Digits
OPTIONAL
A code describing a commodity or a group of commodities pertaining to goods classification.
Data is a number between 1 and 9999999999999999 represented as a string.
Information about the taxes per line item.
Decimal
OPTIONAL
The tax amount for the tax type defined in order.item[n].detail.tax[m].type for the item.
Note that the tax amount provided must reflect the tax amount applied before a discount was applied.
Data is a string that consists of the characters 0-9, '.' and '-' and represents a valid decimal number.
Decimal
OPTIONAL
The tax rate (percentage) applied to the item for the tax type defined in order.item[n].detail.tax[m].type.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
OPTIONAL
The tax type for which the amount specified under order.item[n].detail.tax[m].amount has been paid for this item.
The correct value as used by your acquirer may have to be provided. Contact tyro for details.
Data can consist of any characters
Decimal
OPTIONAL
The discount rate (percentage) applied to this item.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Decimal
OPTIONAL
The tax rate (percentage) of the tax charged for this item.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
OPTIONAL
The type of tax charged for this item.
The correct value as used by your acquirer may have to be provided. Contact tyro for details.
Data can consist of any characters
Digits
OPTIONAL
The United Nations Standard Products and Services Code (UNSPSC) for the item.
Data is a number between 1 and 9999999999999999 represented as a string.
Digits
OPTIONAL
The Universal Product Code (UPC) for the item.
Data is a number between 1 and 9999999999999999 represented as a string.
Enumeration
OPTIONAL
Provide the industry category to send this line item to your acquirer for specialized processing as industry data.
Such processing might have legal obligations, which are your responsibility. Do not provide an industry category, unless you are certain it applies to you, and is accepted by your acquirer.
We support the following industry standard processing:US health care processing using the IIAS standard.The supported values for this field are:HEALTHCARE_VISION, HEALTHCARE_DENTAL, HEALTHCARE_PRESCRIPTION, HEALTHCARE_OTHERWe formulate an IIAS message by summing the amounts of all the line items with the same industry category. The amount of a line item is computed as:(order.item.unitPrice + order.item.tax) * order.item.quantity
Value must be a member of the following list. The values are case sensitive.
HEALTHCARE_DENTAL
HEALTHCARE_OTHER
HEALTHCARE_PRESCRIPTION
HEALTHCARE_VISION
String
OPTIONAL
A short name describing the item.
Data can consist of any characters
Decimal
OPTIONAL
The quantity of the item.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number greater than zero.
String
OPTIONAL
The SKU (Stock Keeping Unit) or the item identifier for this item.
Data can consist of any characters
Decimal
OPTIONAL
The discount amount applied to this item.
Data is a string that consists of the characters 0-9, '.' and '-' and represents a valid decimal number.
String
OPTIONAL
The unit of measure used for the item quantity.
The correct value as used by your acquirer may have to be provided. Contact tyro for details.
Data can consist of any characters
Decimal
OPTIONAL
The cost price for the item.
This amount is multiplied with the item quantity (item.quantity) to determine the total amount for this item (item.amount). This amount does not include the tax amount and/or discount amount applicable to this item.
Data is a string that consists of the characters 0-9, '.' and '-' and represents a valid decimal number.
Decimal
OPTIONAL
The tax amount for the item.
This amount is multiplied with the item quantity (item.quantity) to determine the total tax amount for this item.
Data is a string that consists of the characters 0-9, '.' and '-' and represents a valid decimal number.
Decimal
OPTIONAL
The total item amount for this transaction.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
OPTIONAL
Your note about this transaction.
Data can consist of any characters
Information about Foreign Exchange (FX) rates provided by your Multi-Currency Pricing service provider.
Information about the Foreign Exchange (FX) rate that was used to calculate the amounts for this payment.
String
OPTIONAL
Unique identifier for the Foreign Exchange (FX) rate quote as returned in the SHOPPING_OPTIONS_INQUIRY response.
Data can consist of any characters
Enumeration
OPTIONAL
Indicates if the payer provided consent for storing the payment details they have provided for this payment.
Value must be a member of the following list. The values are case sensitive.
MERCHANT_INITIATED_PAYMENTS
The payer has provided consent for storing their card details for the purpose of subsequent merchant-initiated payments.
PAYER_DECLINED
The payer declined to provide consent for storing their card details.
PAYER_INITIATED_PAYMENTS
The payer has provided consent for storing their card details for the purpose of subsequent payer-initiated payments.
Enumeration
OPTIONAL
Indicates that a transaction requires approval to proceed with the order.
Value must be a member of the following list. The values are case sensitive.
REQUESTED
Requested
String
OPTIONAL
An optional identifier for this transaction.
Data can consist of any characters
Information about transactions related to this transaction.
For example, if this transaction is a merchant-initiated transaction, then this parameter group may contain information about the initial cardholder-initiated transaction.
Information about the first cardholder-initiated transaction (also called CIT) in a series of payments (MIT).
Enumeration
OPTIONAL
Indicates the channel of authorization of first cardholder-initiated transaction (also called CIT) in a series of payments (MIT).
You must provide the channel information in this field (along with transaction.acquirer.traceId API field) if you have processed the cardholder-initiated transaction (also called CIT) for the payment agreement outside the gateway.
For example, set this value in your merchant-initiated transaction (MIT) to MOTO if the cardholder-initiated transaction (CIT) was Mail Order Telephone Order.
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
MAIL_ORDER
Transaction received by mail.
MOTO
Transaction received by mail or telephone.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.
Boolean
OPTIONAL
Indicates that this merchant initiated transaction is a resubmission for a previous authorization which failed due to insufficient funds.
A resubmission transaction must also contain the 'scheme transaction Id' from the associated failed transaction. You can provide the referenceOrderId of the relevant order and the gateway will include the 'scheme transaction Id' of the last failed authorization on the order in the resubmission transaction. Alternatively, you can provide the 'scheme transaction Id' of the failed transaction in the resubmission transaction using the field transaction.acquirer.traceId.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
Use this parameter group when transaction service location is different than your registered business location.
String
OPTIONAL
The city where cardholder received the service.
Data can consist of any characters
Upper case alphabetic text
OPTIONAL
The country where cardholder received the service.
Data must consist of the characters A-Z
Alphanumeric + additional characters
OPTIONAL
The zip or postal code where cardholder received the service.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
String
OPTIONAL
The state or province where cardholder received the service.
The value must match the second part of the ISO 3166-2 code. For an address in the United States provide the 2-letter ISO 3166-2 state code. For US military bases provide one of AE, AA, AP. For an address in Canada provide the 2-letter ISO 3166-2 province code.
Data can consist of any characters
Decimal
OPTIONAL
The total shipping and handling amount for the transaction, including taxes on the shipping and/or handling.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Decimal
OPTIONAL
The tax amount levied on the shipping and handling amount for the transaction.
This amount is included in the shipping and handling amount provided in field transaction.shippingAndHandlingAmount.
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
Decimal
OPTIONAL
The tax rate applied to the shipping and handling amount for the transaction to determine the shipping and handling tax amount.
For a tax rate of 2.5% provide 0.025.
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
Enumeration
OPTIONAL
Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT. You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by tyro.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.
String
OPTIONAL
The identifier of the source transaction that you wish to reference in this transaction.
That is the {transactionId} URL field for REST and the transaction.id field for NVP.
For example: This can be the transaction id of the contactless transaction which was processed with a single tap indicator and you want to provide the PIN in this request.
Data can consist of any characters
Use this parameter group to provide a breakdown of tax types, amount per tax type, and rate per tax type included in transaction.taxAmount.
Decimal
OPTIONAL
The tax amount included in this transaction for the tax type.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Decimal
OPTIONAL
The tax rate (percentage) used to determine the tax amount included in this transaction for the tax type.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
OPTIONAL
The type of tax included in the transaction amount.
The correct value as used by your acquirer may have to be provided. Contact tyro for details.
Data can consist of any characters
Decimal
OPTIONAL
The total tax amount for the transaction.
You only need to provide this field when you capture or refund part of the order amount. In this case, the amount must not exceed order.taxAmount. If you provide this field when you capture or refund the full amount of the order, then the value provided must match order.taxAmount.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Enumeration
OPTIONAL
Indicates your tax status for this transaction.
Value must be a member of the following list. The values are case sensitive.
EXEMPT
Indicates that you are exempt from tax.
NOT_EXEMPT
Indicates that you are not exempt from tax.
NOT_PROVIDED
Indicates that you are not providing information about being exempt from tax.
Enumeration
OPTIONAL
Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT. You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by tyro.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.
Enumeration
OPTIONAL
The strategy used to verify the payment instrument details before they are stored.
You only need to specify the verification strategy if you want to override the default value configured for your merchant profile. When the verification strategy is
- BASIC you must also provide the card expiry date in the sourceOfFunds.provided.card.expiry parameter group.
- ACQUIRER you must also provide the card expiry date in the sourceOfFunds.provided.card.expiry parameter group and the currency in the transaction.currency field.
- ACCOUNT_UPDATER you must also provide a currency in the transaction.currency field and the sourceOfFunds parameter group is optional.
- you need to be enabled for Account Updater by tyro.
- you can subsequently inquire about any updates the gateway has made to the token based on the Account Updater response using the RETRIEVE_TOKEN or SEARCH_TOKENS operations.
Used to nominate which type of Verification to use when payment instrument details are stored in the token repository. This setting overrides the default settings in Merchant Manager.
Value must be a member of the following list. The values are case sensitive.
ACCOUNT_UPDATER
The gateway does not perform any validation or verification of the payment details provided, but schedules an Account Updater request to your acquirer to check for any updates to the payment details stored against the token. Once the Account Update request has been executed and indicates that the payment details have changed, the gateway automatically updates the payment details stored against the token or marks the token as invalid.
ACQUIRER
The gateway performs a Web Services API Verify request. Depending on the payment type, you may need to provide additional details to enable the submission of a Verify request.
BASIC
The gateway verifies the syntax and supported ranges of the payment instrument details provided, .e.g for a card it validates the card number format and checks if the card number falls within a valid BIN range.
NONE
The gateway does not perform any validation or verification of the payment instrument details provided.
Provide the details for the Amex Express Checkout Wallet.
String
OPTIONAL
An Amex Express Checkout authorization code.
You need this to get the customer details from Amex Express Checkout.Get this value from the Amex Express Checkout Success callback, after the Amex Express Checkout interaction is completed.
Data can consist of any characters
String
OPTIONAL
The type of card the payer selects for the payment.
Get this value from the Amex Express Checkout Success callback, after the Amex Express Checkout interaction is completed..
Data can consist of any characters
String
OPTIONAL
A unique identifier provided for end to end tracking of an Amex Express Checkout interaction.
Get this value from the Amex Express Checkout Success callback, after the Amex Express Checkout interaction is completed.
Data can consist of any characters
String
OPTIONAL
The identifier of the wallet from which the payer selects their card.
Get this value from the Amex Express Checkout Success callback, after the Amex Express Checkout interaction is completed.
Data can consist of any characters
Information about the payer's MasterPass wallet.
Url
OPTIONAL
The MasterPass URL the gateway will use to retrieve the cardholder's payment details into the session.
Ensure that this is a valid URL according to RFC 1738.
String
OPTIONAL
Provide the value of the field oauthToken as returned by the MasterPass lightbox.
The gateway will use this, to retrieve the payer's payment details for the respective interaction from MasterPass and store them against the payment session (identified in field session.id). Mandatory for the MASTERPASS_ONLINE Wallet Provider.
Data can consist of any characters
String
OPTIONAL
Provide the value of the field oauthVerifier as returned by the MasterPass lightbox.
The gateway will use this, to retrieve the payer's payment details for the respective interaction from MasterPass and store them against the payment session (identified in field session.id). Mandatory for the MASTERPASS_ONLINE Wallet Provider.
Data can consist of any characters
Url
OPTIONAL
The URL of the page that will initialize the MasterPass lightbox.
Ensure that this is a valid URL according to RFC 1738.
Url
OPTIONAL
The URL of the outer or parent page that will initialize the MasterPass lightbox.
Provide this field only when the Lightbox will be invoked from a frame that's on a merchant site, and when that frame has a different domain than the merchant site.
Ensure that this is a valid URL according to RFC 1738.
Parameters used to obtain wallet details from MasterPass for an Express Checkout interaction.
The wallet details are added to the session.
String
OPTIONAL
A wallet token provided by the gateway for Masterpass paired accounts.
Provide this token to obtain pre-checkout data from the payer's wallet for future interactions.
Data can consist of any characters
String
OPTIONAL
The MasterPass identifier for the card.
Provide this value to MasterPass in the cardId parameter when you initiate a 'Connected Checkout' or 'Express Checkout' MasterPass interaction for this wallet.
Data can consist of any characters
String
OPTIONAL
The MasterPass identifier for the shipping address.
Provide this value to MasterPass in the shippingId parameter when you initiate a 'Connected Checkout' or 'Express Checkout' MasterPass interaction for this wallet.
Data can consist of any characters
Url
OPTIONAL
The URL of the page that will initialize the MasterPass lightbox.
Ensure that this is a valid URL according to RFC 1738.
String
OPTIONAL
A MasterPass transaction identifier.
Provide this value to MasterPass when you initiate a 'Connected Checkout' or 'Express Checkout' MasterPass interaction for this wallet.
Data can consist of any characters
Url
OPTIONAL
The URL of the outer or parent page that will initialize the MasterPass lightbox.
Provide this field only when the Lightbox will be invoked from a frame that's on a merchant site, and when that frame has a different domain than the merchant site.
Ensure that this is a valid URL according to RFC 1738.
Provide details about the Secure Remote Commerce (SRC) wallet interaction.
Enumeration
OPTIONAL
Identifies the scheme for which the SRC Correlation ID is provided.
Value must be a member of the following list. The values are case sensitive.
AMERICAN_EXPRESS
American Express
MASTERCARD
Mastercard
VISA
Visa
String
OPTIONAL
Unique identifier assigned by the Secure Remote Commerce (SRC) System for the interaction.
This identifier is used by the gateway to retrieve the payer's payment details.
Data can consist of any characters
Provide the details for the VisaCheckout Wallet.
String
OPTIONAL
Provide the value of the field callId as returned by the Visa Checkout lightbox.
The gateway will use this, to retrieve the payer's payment details for the respective interaction from Visa Checkout and store them against the payment session (identified in field session.id). Mandatory for the VISA_CHECKOUT Wallet Provider.
Data can consist of any characters
Response Copied to clipboard
Fields Copied to clipboard
A commercial agreement you have with the payer that allows you to store and use their payment details for later payments.
For example, an agreement to a series of recurring payments (a mobile phone subscription), an agreement to take payment for a purchase by a series of installments (hire purchase), an agreement to make additional payments when required (account top up), or to fulfil a standard industry practice (no show penalty charge).
Do not provide this parameter group if you are storing the payment details for subsequent payer-initiated payments only.
See Credential on File, Cardholder, and Merchant Initiated Transactions for details.
Enumeration
CONDITIONAL
Indicates if all the payments within the agreement use the same amount or if the amount differs between the payments.
The field must be provided for recurring payment agreements.
Value must be a member of the following list. The values are case sensitive.
FIXED
All payments in the recurring payment agreement have the same amount. Examples include magazine subscriptions or gym memberships.
VARIABLE
The amount for the payments within the recurring payment agreement differs between payments. Examples include usage-based charges like utility or phone bills.
String
CONDITIONAL
Additional information requested for the agreement which cannot be passed using other available data fields.
This field must not contain sensitive data.
Data can consist of any characters, but sensitive data will be rejected
Date
CONDITIONAL
Date at which your agreement with the payer to process payments expires.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
String
CONDITIONAL
Your identifier for the agreement you have with the payer to process payments.
When you collect cards from your payers and store them for later use, you must provide an agreement ID when you use the stored values for:
- Recurring payments: you have an agreement with the payer that authorizes you to automatically debit their account at agreed intervals for fixed or variable amounts. For example, gym membership, phone bills, or magazine subscriptions.
- Installment payments: you have an agreement with the payer that authorizes you to process multiple payments over an agreed period of time for a single purchase. For example, the payer purchases an item for $1000 and pays for it in four monthly installments.
- Unscheduled: you have an agreement with the payer that authorizes you to process future payments when required. For example, the payer authorizes you to process an account top-up transaction for a transit card when the account balance drops below a certain threshold.
- Industry Practice: you have an agreement with the payer that authorizes you to initiate additional transactions to fulfil a standard business practice related to an original payment initiated by the payer. For example, a delayed charge for use of the hotel mini bar after the payer has checked out or a no show penalty charge when the payer fails to show for a booking.
Data can consist of any characters
Decimal
CONDITIONAL
The maximum amount for a single payment in the series as agreed with the payer under your agreement with them.
The amount must be provided in the currency of the order.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Decimal
CONDITIONAL
The minimum amount for a single payment in the series as agreed with the payer under your agreement with them.
The amount must be provided in the currency of the order.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Integer
CONDITIONAL
The minimum number of days between payments agreed with the payer under your agreement with them.
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
Integer
CONDITIONAL
The number of merchant-initiated payments within the recurring payment agreement.
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
Enumeration
CONDITIONAL
The frequency of the payments within the series as agreed with the payer under your agreement with them.
Value must be a member of the following list. The values are case sensitive.
AD_HOC
The agreement if for payments on an ah-hoc basis.
DAILY
The agreement if for a daily payment.
FORTNIGHTLY
The agreement if for a fortnightly payment.
MONTHLY
The agreement if for a monthly payment.
OTHER
The agreement is for payments according to a schedule other than the ones listed in the other enumeration values for this field.
QUARTERLY
The agreement if for a quarterly payment.
TWICE_YEARLY
The agreement if for a payment twice a year.
WEEKLY
The agreement if for a weekly payment.
YEARLY
The agreement if for a yearly payment.
For an installment agreement where the payer purchased goods and/or services from a retailer but entered an installment agreement to pay for this purchase with you, you must provide details about the retailer.
String
CONDITIONAL
Provide an abbreviation of the retailer's trading name that can be used by the issuer to indicate the retailer on the payer's statement.
Data can consist of any characters
String
CONDITIONAL
A 4-digit code used to classify the retailer's business by the type of goods or services it offers.
Data can consist of any characters
String
CONDITIONAL
The retailer's trading name.
Data can consist of any characters
Date
CONDITIONAL
This is the effective start date for the payment agreement.
Cannot be in the past.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
Enumeration
CONDITIONAL
The type of commercial agreement that the payer has with you.
Specify the agreement type when you have provided a value for agreement.id and this payment is the first in a series of payments. The default value is OTHER.
The gateway will use the value you specify for subsequent payments in the series.
Value must be a member of the following list. The values are case sensitive.
INSTALLMENT
An agreement where the payer authorizes the payment for a single purchase to be split into a number of payments processed at agreed intervals. For example, pay for a purchase in six monthly installments.
OTHER
An agreement where you want to link related payments for any purpose other than processing recurring, installment, or unscheduled payments. For example, split tender payments.
RECURRING
An agreement where the payer authorizes you to process repeat payments for bills or invoices at agreed intervals (for example, weekly, monthly). The amount might be fixed or variable.
UNSCHEDULED
An agreement where the payer authorizes you to automatically deduct funds for a payment for an agreed purchase when required (unscheduled). For example, auto top-ups when the account value falls below a threshold.
Information used to manage interactions with the payment provider if you are offering your payment page in an app or are redirecting the payer to the provider's app.
If you are offering your payment page on a website or are redirecting the payer's browser to the provider's website, use the browserPayment parameter group.
Url
CONDITIONAL
The URL of your app to which you want the payer to be redirected on completing the payment interaction at the payment provider's website or in the payment provider's app.
The same return URL will be used by the gateway to redirect the payer irrespective of the success or otherwise of the payment interaction. This field is not required if the payer is to be redirected to your website or if the payment provider's checkout flow is presented on a modal window on top of your payment page.
Data must be an absolute URI conforming to the URI syntax published by IETF RFC 2396.
Information about how the payer's identity is verified.
For example, using 3-D Secure authentication.
This parameter group include payer authentication options available to you, parameters you need to perform payer authentication for an available method, and the results of payer authentication.
Information about payer authentication using 3-D Secure authentication.
Only provide these fields if you authenticated the payer using a different 3-D Secure service provider. If you authenticated the payer using the gateway, then provide authentication.transactionId instead.
Parameters in this group apply to both 3-D Secure authentication version 1 and 3-D Secure Authentication version 2.
Depending on the 3-D Secure authentication version applicable you will also need additional parameters:
- 3-D Secure authentication version 1: see the authentication.3ds1 parameter group.
- 3-D Secure authentication version 2: see the authentication.3ds2 parameter group.
Alphanumeric
CONDITIONAL
Indicates the security level of the transaction.
This is the Electronic Commerce Indicator (ECI) value provided by the issuer's Access Control Server (ACS) to indicate the results of the attempt to authenticate the payer.
Data may consist of the characters 0-9, a-z, A-Z
Base64
CONDITIONAL
The base64 encoded value generated by the issuer.
The authentication token Included in subsequent transaction request messages and used by the card scheme to verify that the authentication occurred and the values provided are valid. The token should be used unaltered.
For 3DS version 1, this field corresponds to the Cardholder Authentication Verification Value (CAVV) for Visa, the Accountholder Authentication Value (AAV) for MasterCard and JCB, or the American Express Verification Value (AEVV) for American Express.
For 3DS version 2, this field corresponds to the Authentication Value.
Data is Base64 encoded
String
CONDITIONAL
A unique identifier for the 3-D Secure authentication transaction.
For 3DS version 1, this field corresponds to the XID. The XID is an identifier generated by the gateway on behalf of the merchant.
For 3DS version 2, this field corresponds to the identifier assigned by the scheme directory server.
This identifier should be used in subsequent operation requests unaltered.
An XID submitted in this field must be in base64 format.
Data can consist of any characters
Information about payer authentication using 3-D Secure authentication version 1.
Only provide these fields if you authenticated the payer using a different 3-D Secure service provider. If you authenticated the payer using the gateway, then provide authentication.transactionId instead.
Alpha
CONDITIONAL
Indicates the result of payer authentication with the issuer.
This is the value returned in the transaction status field of the Payer Authentication Response (PARes) message from the card Issuer's Access Control Server (ACS). For example, Y, N, A, or U. Refer to the relevant documentation for Mastercard SecureCode™, Verified by Visa™, JCB J/Secure™, American Express SafeKey™, or Diners Club ProtectBuy™.
Data may consist of the characters a-z, A-Z
Alpha
CONDITIONAL
Indicates whether or not payer authentication is available for the card number you provided.
This is for experts only - most users should use the response.gatewayRecommendation field.
This is the value returned in the 'enrolled' field of the Verify Enrollment Response (VERes) message from the card scheme's Directory Server. For example, Y, N, or U. Refer to the relevant documentation for Mastercard SecureCode™, Verified by Visa™, JCB J/Secure™, American Express SafeKey™, or Diners Club ProtectBuy™.
Data may consist of the characters a-z, A-Z
Information about payer authentication using 3-D Secure authentication version 2.
String
CONDITIONAL
Reference number assigned to the issuer's Access Control Server (ACS) by EMV Co upon approval of the ACS.
This field corresponds to EMVCo field acsReferenceNumber.
Data can consist of any characters
String
CONDITIONAL
A unique transaction identifier assigned by the Access Control Server to identify the 3DS transaction.
Data can consist of any characters
Enumeration
CONDITIONAL
The EMV 3DS authentication scheme that was used to process the authentication request.
You must provide this field for co-branded card transactions that were authenticated outside MPGS using an external 3DS provider.
For example, for externally authenticated Mada co-branded transactions, you must provide either MADA, MASTERCARD or VISA to specify the 3DS directory server.
Value must be a member of the following list. The values are case sensitive.
AMEX
for American Express SafeKey EMV 3DS authentications
CARTE_BANCAIRE
for FAST'R by CB EMV 3DS authentications
DISCOVER
for Diners Club/Discover ProtectBuy EMV 3DS authentications
ITMX
for ITMX LSS EMV 3DS authentications
JCB
for JCB J/Secure EMV 3DS authentications
MADA
for mada secure EMV 3DS authentications
MASTERCARD
for Mastercard Identity Check EMV 3DS authentications
UNIONPAY
for UnionPay EMV 3DS authentications
VISA
for Visa Secure EMV 3DS authentications
JSON Text
CONDITIONAL
Additional information returned by the scheme or issuer in the authentication response that must be included (together with the standard authentication details) when submitting the transaction for processing by the acquirer.
Data is valid Json Format
String
CONDITIONAL
Reference number assigned to the Directory Server (DS) by EMV Co upon approval of the DS.
This field corresponds to EMVCo field dsReferenceNumber.
Data can consist of any characters
Alphanumeric + additional characters
CONDITIONAL
The version of the EMV 3-D Secure protocol used to perform 3-D Secure authentication, in the format specified by EMVCo.
For example, 2.1.0
Data may consist of the characters 0-9, a-z, A-Z, '.'
Information provided by the 3-D Secure Software Development Kit (SDK) that is used by an app on the payer's device to enable 3-D Secure authentication of the payer to be performed in-app.
You must populate the fields in this parameter group when you authenticate the payer in-app using 3-D Secure authentication version 2.
String
CONDITIONAL
A unique identifier for the app on the payer's device.
The 3-D Secure SDK generates this identifier each time the app is installed or updated.
This field corresponds to EMVCo field sdkAppID
Data can consist of any characters
String
CONDITIONAL
Information about the payer's device collected and encrypted by the 3-D Secure SDK.
The data is a JSON Web Encryption (JWE) object in JSON format. When using the REST/JSON gateway API, express this as a JSON string (i.e. the embedded quotes will be escaped).
This field corresponds to EMVCo field sdkEncData
Data can consist of any characters
JSON Text
CONDITIONAL
A public key generated by the 3-D Secure SDK.
This key is used to establish a secure session between the 3DS SDK and the issuer's Access Control Server (ACS) when the payer is required to be presented with an authentication challenge.
The key is a JSON Web Key (JWK) object in JSON format. When using the REST/JSON gateway API, express this as a JSON string (i.e the embedded quotes will be escaped).
This field corresponds to EMVCo field sdkEphemPubKey
Data is valid Json Format
Enumeration
CONDITIONAL
The User Interface (UI) formats that the payer's device supports.
These are the formats that can be used to render the screens presented to the payer during an authentication challenge.
You only need to provide this value if you only support one of these formats.
This field corresponds to EMVCo data element sdkInterface in the field deviceRenderOptions.
Value must be a member of the following list. The values are case sensitive.
HTML
The device supports HTML format.
NATIVE
The device supports the UI format native to the payer's device.
String
CONDITIONAL
An identifier of the vendor and version of the 3-D Secure SDK assigned by EMVCo.
This field corresponds to EMVCo field sdkReferenceNumber
Data can consist of any characters
Integer
CONDITIONAL
The duration (in seconds) available to the payer to authenticate.
Will default to 900 if not provided. Note: The value will be rounded up to the nearest minute.
This field corresponds to EMVCo field sdkMaxTimeout
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
String
CONDITIONAL
A unique identifier assigned by the 3-D Secure SDK for the transaction.
This field corresponds to EMVCo field sdkTransID
Data can consist of any characters
Comma separated enumeration
CONDITIONAL
Indicates the UI types which the SDK supports for displaying authentication challenges within the app.
A comma separated list of the payer authentication methods that you will accept for this payment.
You only need to provide this value if all of these values are not supported.
Note: OTHER_HTML is only supported when authentication.3ds2.sdk.interface allows a HTML UI format.
This field corresponds to EMVCo data element sdkUiType in the field deviceRenderOptions.
Value must be one or more comma separated members of the following list. The values are case sensitive.
TEXT
The payer is asked to enter text into a field displayed on the UI. For example, ask the payer to enter a One Time Password sent to their registered mobile phone number.
SINGLE_SELECT
The payer is asked to select a single option from a number of presented options. For example, ask the payer if they want a One Time Password to be sent to either their email address or mobile phone number registered with their issuer.
MULTI_SELECT
The payer is asked to select multiple options from a number of presented options. For example, ask the payer to select valid responses to a question.
OUT_OF_BAND
The payer is presented with screens rendered by an out-of-band service during an authentication challenge, For example, the payer is asked to confirm the payment from their banking app.
OTHER_HTML
The payer is presented with an authentication challenge using other mechanisms supported in HTML but not in the native UI format. For example, the payer is asked to confirm an image presented on the screen.
String
CONDITIONAL
A code indicating the reason for the transaction status returned in authentication.3ds2.transactionStatus.
Refer to the EMVCo specification for 3-D Secure.
Data can consist of any characters
Alpha
CONDITIONAL
Indicates the result of payer authentication with the issuer.
This is the value returned in the transaction status field from the issuer's Access Control Server (ACS). For example, Y, N, U, A, R
Refer to the EMVCo specification for 3-D Secure.
Data may consist of the characters a-z, A-Z
Comma Separated Enumeration
CONDITIONAL
A comma separated list of the payer authentication methods that you will accept for this payment.
You only need to provide a value if you want to restrict the authentication methods you will accept.
If you do not specify a value, then the gateway treats it as if you will accept all available authentication methods.
If you accept both 3DS2 and 3DS1, then the gateway will use 3-D Secure version 2 if supported by the issuer and fallback to use 3-D Secure version 1 if it is not.
Value must be one or more comma separated members of the following list. The values are case sensitive.
3DS1
3-D Secure Version 1
3DS2
3-D Secure Version 2
Decimal
CONDITIONAL
The amount for which the payer authentication has been performed.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Enumeration
CONDITIONAL
Indicates if you want the payer to be presented with an authentication challenge for this transaction.
You can use this to support local mandates or your risk tolerance. For example, you may prefer that a challenge is always performed when you store card details on file.
If you do not provide a value, the gateway will use NO_PREFERENCE. If there is no payer present (for example, recurring payments), then the gateway will ignore this field and use NO_CHALLENGE.
Note: 'challenge' means requiring the payer to take action to identify themselves, for example, entering a password.
Value must be a member of the following list. The values are case sensitive.
CHALLENGE_MANDATED
You require that the payer is presented with a challenge.
CHALLENGE_PREFERRED
You prefer that the payer is presented with a challenge.
NO_CHALLENGE
You prefer that the payer is not presented with a challenge.
NO_PREFERENCE
You do not have a preference. The issuer may present the payer with a challenge.
REQUEST_TRUSTED_MERCHANT_LISTING
You want the issuer to present the payer with a challenge and invite the payer to add you to the list of trusted merchant for this card. If the payer agrees, the response will contain authentication.psd2.trustedMerchantStatus=ON_LIST. This will allow you to request a trusted merchant exemption the next time you authenticate the payer for a payment with this card.
Enumeration
CONDITIONAL
Indicates the channel in which the authentication request is being initiated.
Value must be a member of the following list. The values are case sensitive.
MERCHANT_REQUESTED
The merchant is requesting authentication of a cardholder without the payer being available for interaction (for example. as part of processing of a recurring payment).
PAYER_APP
Payer is interacting via an application on their device which uses an EMVCo-certified SDK.
PAYER_BROWSER
Payer is interacting via web browser (for example, with the merchant's ecommerce web-site).
String
CONDITIONAL
Description of the goods being purchased.
If supported, this description will be displayed on the authentication UI presented to the payer.
Data can consist of any characters
Url
CONDITIONAL
The URL to which the gateway will send the 3DS Method completion notification.
You only need to provide this value if you want to be notified on completion of the 3DS Method call.
If you do not specify a value, and if Method URL is supported for the transaction, then the gateway will handle the Method completion on behalf of you.
Ensure that this is a valid URL according to RFC 1738.
This parameter group is only applicable if you are subject to the Regulatory Technical Standards (RTS) requirements for Strong Customer Authentication (SCA) under the Payment Services Directive 2 (PSD2) regulations in the European Economic Area.
It provides details about SCA exemptions under PSD2.
Enumeration
CONDITIONAL
Indicates why this payment qualifies for exemption from Strong Customer Authentication (SCA) under the Payment Services Directive 2 (PSD2).
Note:
- For recurring payments provide the RECURRING_PAYMENT value only if the amount is the same. If the amount varies, provide MERCHANT_INITIATED_TRANSACTION instead.
Value must be a member of the following list. The values are case sensitive.
AUTHENTICATION_OUTAGE
Allows the merchant to claim an exemption because authentication was not possible due to a technical outage.
AUTO
If either a LOW_RISK or LOW_VALUE_PAYMENT or TRUSTED_MERCHANT exemption applies to the transaction, it is automatically claimed by the gateway on behalf of the merchant.
LOW_RISK
Exemption is claimed because the acquirer has a low fraud rate.
LOW_VALUE_PAYMENT
Exemption is claimed as the amount is below 30 Euro.
MERCHANT_INITIATED_TRANSACTION
The transaction is excluded as it was initiated by the merchant based on an agreement with the payer. For example, a recurring payment (for a varied or fixed amount), installment payment, or account top-up. In these cases, the payer is not present and cannot participate in an authentication interaction. Merchant initiated transactions are only applicable to subsequent transactions on the order and are out of scope of the PSD2 RTS on Strong Customer Authentication (SCA). The payer must be authenticated during the first transaction that established the agreement.
NONE
An exemption is not claimed for this transaction. The merchant requires Strong Customer Authentication (SCA) be performed.
RECURRING_PAYMENT
The transaction is exempt as it was initiated by the merchant based on an agreement with the payer for a recurring payment for a fixed amount. This value is only applicable to subsequent transactions on the order. In this case, the payer is not present and cannot participate in an authentication interaction. The payer must be authenticated during the first transaction that established the agreement.
SCA_DELEGATION
The transaction is exempt as the issuer has delegated Strong Customer Authentication (SCA) using a compliant method to a third party. For example, the payer was subject to SCA when a card was enrolled with a wallet provider or SCA was delegated to the merchant.
SECURE_CORPORATE_PAYMENT
The transaction is exempt as it is a corporate or Business-to-Business (B2B) payment performed using dedicated payment processes and protocols that are not available to consumers and offer at least equivalent security levels.
TRUSTED_MERCHANT
The transaction is exempt because the payer has added you to the list of their trusted merchants (as maintained by the issuer).
Enumeration
CONDITIONAL
Indicates the context in which payer authentication is being requested.
If you do not provide a value, the gateway will use PAYMENT_TRANSACTION as the default.
If you are authenticating the payer when establishing a payment agreement with your payer for a series of recurring, installment or unscheduled payments you must provide details about the agreement in the agreement parameter group in the AUTHENTICATE_PAYER request for this transaction.
Note:
- • If you set this value to ADD_CARD or MAINTAIN_CARD, then set order.amount to zero and order.currency to any currency you support.
- • If the authentication scheme that applies to the account does not support the purpose that you have requested, this call will return an authenticationStatus of AUTHENTICATION_NOT_SUPPORTED.
- • If you set this to REFRESH_AUTHENTICATION then when you perform the subsequent Authenticate Payer operation you must provide details of the original authentication, either by providing the authentication data explicitly via the fields customer.account.history.issuerAuthentication.acsTransactionId, customer.account.history.issuerAuthentication.authenticationToken, customer.account.history.issuerAuthentication.time and customer.account.history.issuerAuthentication.type, or by providing the gateway reference of the original authentication operation in customer.account.history.issuerAuthentication.transactionId.
- • If you set this value to AGREEMENT_CANCELLATION, you must provide the agreement.id and order.amount for which the agreement was registered in the AUTHENTICATE_PAYER request.
Value must be a member of the following list. The values are case sensitive.
ADD_CARD
Authentication performed before a payer's card is stored on file either directly by the merchant or using the gateway's tokenization feature. A payment is not being processed.
AGREEMENT_CANCELLATION
Authentication performed before cancelling the agreement.
MAINTAIN_CARD
Authentication performed before updating details of a payer's card stored on file either directly by the merchant or using the gateway's tokenization feature. A payment is not being processed.
PAYMENT_TRANSACTION
Authentication performed when of processing a card payment.
REFRESH_AUTHENTICATION
Authentication performed in order to obtain a new authentication token to replace one previously obtained for the order which is no longer valid (for example, because the order amount has changed in the time between originally performing authentication and submitting the financial transaction).
Url
CONDITIONAL
The URL to which you want to redirect the payer after completing the payer authentication process.
This will be a URL on your website, with the URL encoded as defined in RFC3986. This means special characters such spaces, hyphens, etc must be encoded.
You must provide this URL, unless you are certain that there will be no interaction with the payer.
Ensure that this is a valid URL according to RFC 1738.
DateTime
CONDITIONAL
Date and time of the payer authentication being performed.
An instant in time expressed in ISO8601 date + time format - "YYYY-MM-DDThh:mm:ss.SSSZ"
String
CONDITIONAL
The transactionId you used for the Initiate Authentication operation.
Data can consist of any characters
Authorisation response fields for a standalone capture request.
Alphanumeric
CONDITIONAL
The authentication token verification result code provided by the scheme.
For Discover ProtectBuy transactions this is known as CAVV (Cardholder Authentication Verification Value) result code.
Data may consist of the characters 0-9, a-z, A-Z
ASCII Text
CONDITIONAL
The acquirer AVS response code generated by the card issuing institution.
Data consists of ASCII characters
String
CONDITIONAL
Indicates the card level result returned by the issuer.
Data can consist of any characters
String
CONDITIONAL
CSC Incorrect Indicator.
An indicator, provided by the Issuer in the authorization response, to identify the presence of an invalid card security code (CSC). If there is an error, the Issuer will respond with the 1-byte CSC Error Code (Y).
Data can consist of any characters
Alphanumeric
CONDITIONAL
An Indicator, if a Card security code was provided for the Transaction, as returned by the acquirer.
Data may consist of the characters 0-9, a-z, A-Z
String
CONDITIONAL
Indicates if the card used is a commercial card.
Data can consist of any characters
String
CONDITIONAL
Indicates the type of commercial card as returned by the card issuer.
Data can consist of any characters
Digits
CONDITIONAL
The local date, in MMDD format, in which the authorization was received from the acquirer, issuer or local terminal.
Data is a string that consists of the characters 0-9.
String
CONDITIONAL
Indicates the code of the financial network that was used to process the transaction with the issuer.
Data can consist of any characters
Date
CONDITIONAL
The date for the Authorization as returned by the scheme.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
String
CONDITIONAL
Indicates the market or the industry associated with the payment.
For example, B may indicate "bill payment" depending on the acquirer.
Data can consist of any characters
String
CONDITIONAL
Indicates the specific card information conditions for capture that are available when the card transaction occurs at point of service.
Data can consist of any characters
String
CONDITIONAL
The POS Entry Mode provided to Discover (JCB (US Domestic only), and Diners) for the authorization.
Bytes 1-2: Discover (JCB (US Domestic only), and Diners) POS Entry Mode
Byte 3: Discover (JCB (US Domestic only), and Diners) Pin Entry Capability
Byte 4: RFU (Always zero)
Note: Only the first 3 bytes are required for settlement processing.
Data can consist of any characters
String
CONDITIONAL
Identifies the type of Card Transaction sent to Card Acceptor.
Data can consist of any characters
String
CONDITIONAL
The response code which indicates the status of the transaction.
Data can consist of any characters
String
CONDITIONAL
The ACI (Authorization Characteristics Indicator) returned by the issuer.
Data can consist of any characters
Digits
CONDITIONAL
The local time, in HHMMSS format, in which the authorization was received from the acquirer, issuer or local terminal.
Data is a string that consists of the characters 0-9.
Time Offset
CONDITIONAL
The local time zone, in +hhmm or -hhmm format, in which the authorization was received from the acquirer, issuer or local terminal.
Data must comply with ISO 8601 UTC time offset format, +hhmm or -hhmm.
String
CONDITIONAL
Indicates the magnetic stripe condition and the vulnerability for fraud in Discover Network Card Transactions.
Data can consist of any characters
String
CONDITIONAL
The unique identifier for the transaction returned by the issuer.
Data can consist of any characters
Alphanumeric
CONDITIONAL
The Transaction Integrity Class (TIC) is an indicator defined by the scheme to evaluate the safety and security of the transaction.
The indicator is only supported by some schemes and for all regions.
Data may consist of the characters 0-9, a-z, A-Z
String
CONDITIONAL
The validation code returned by the issuer.
This value must be stored to be sent with the capture transaction.
Data can consist of any characters
Details of the payer's billing address.
The payer's billing address.
This data may be used to qualify for better interchange rates on corporate purchase card transactions.
String
CONDITIONAL
The city portion of the address.
Data can consist of any characters
String
CONDITIONAL
The name of the company associated with this address.
Data can consist of any characters
Upper case alphabetic text
CONDITIONAL
The 3 letter ISO standard alpha country code of the address.
Data must consist of the characters A-Z
Alphanumeric + additional characters
CONDITIONAL
The post code or zip code of the address.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
String
CONDITIONAL
The state or province of the address.
Data can consist of any characters
String
CONDITIONAL
The three character ISO 3166-2 country subdivision code for the state or province of the address.
Providing this field might improve your payer experience for 3-D Secure payer authentication.
Data can consist of any characters
String
CONDITIONAL
The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Data can consist of any characters
String
CONDITIONAL
The second line of the address (if provided).
Data can consist of any characters
Information used to manage interactions with the payment provider if you are offering your payment page on a website or are redirecting the payer's browser to the provider's website.
If you are offering your payment page in an app or are redirecting the payer to the provider's app, use the appPayment parameter group.
The payer's consent for different operations as captured by you.
For example, the consent can be for storing account details for recurring transactions or token generation, or for using account details while refunding a previous transaction etc.
Boolean
CONDITIONAL
This indicates the payer's consent as recorded by the Merchant to store the account details in the gateway.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
String
CONDITIONAL
The language that you prefer the payment provider to use for pages displayed to the payer.
You can provide either the two-letter primary language tag (for example, en, fr) or the two-letter primary language tag plus the region sub-tag (for example, en-US, fr-CA).
Data must be a language identifier or IETF language tag
Additional information you can provide to control the user interaction flow presented to the payer by Open Banking.
Boolean
CONDITIONAL
Indicates during the checkout flow whether payer has provided consent for refund in order to store payer account details in the gateway.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
Enumeration
CONDITIONAL
The type of transaction you want to create for this payment.For a successful Authorization transaction, you must submit a CAPTURE request to move the funds from the payer's account to your account.
Value must be a member of the following list. The values are case sensitive.
ACCOUNTSETUP
The transaction created in the gateway is an ACCOUNT SETUP transaction.
AUTHORIZE
The transaction created in the gateway is an AUTHORIZATION transaction.
PAY
The transaction created in the gateway is a PAYMENT transaction.
Additional information you can provide to control the user interaction flow presented to the payer by PayPal.
Enumeration
CONDITIONAL
Indicates the action that PayPal displays to the payer prior to being redirected back to your website.
This field is only required when requesting a PayPal billing agreement.
Value must be a member of the following list. The values are case sensitive.
AGREE
After the payer has approved the billing agreement and their browser has been returned to your website, you will not process a payment against this billing agreement at that time.
AGREE_AND_PAY
After the payer has approved the billing agreement and their browser has been returned to your website, you will process a payment against this billing agreement.
Boolean
CONDITIONAL
Indicates whether you want PayPal to display the shipping address to the payer on the PayPal website.
By default, the shipping address is displayed to the payer. For more detailed information about displaying the shipping address on the PayPal website, see PayPal Integration: Display/Override Shipping Address.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
Boolean
CONDITIONAL
Indicates whether you want to allow the payer to change the shipping address for the payment on the PayPal website.
By default, the payer is allowed to change the shipping address. For more detailed information about the payer overriding the shipping address on the PayPal website, see PayPal Integration: Display/Override Shipping Address.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
Enumeration
CONDITIONAL
Indicates where in the checkout flow you want the payer to commit to the payment - on the PayPal website or on your website after returning from the PayPal website.
By default this is set to CONFIRM_AT_PROVIDER.
Value must be a member of the following list. The values are case sensitive.
CONFIRM_AT_MERCHANT
The payer commits to the payment on your website.
CONFIRM_AT_PROVIDER
The payer commits to the payment on the PayPal website.
Url
CONDITIONAL
The URL of your website to which you want the payer's browser to be redirected on completing the payment interaction at the payment provider's website.
The same return URL will be used by the gateway to redirect the payer's browser irrespective of the success or otherwise of the payment interaction. This field is not required if the payer is to be redirected to your app or if the browser payment provider's checkout flow is presented on a modal window on top of your payment page.
Ensure that this is a valid URL according to RFC 1738.
This parameter group captures all information that has been generated by the gateway or third party service provider and will be used by them to help provide the services to you.
String
CONDITIONAL
The attribute name whose value is used by the gateway service or the third party service to identify the payer or their account or your account or any similar detail with them, and which facilitates them to offer their service to you.
Data can consist of any characters
String
CONDITIONAL
The attribute name whose value is used by the gateway service or the third party service to identify the payer or their account or your account or any similar detail with them, and which facilitates them to offer their service to you.
Data can consist of any characters
Information about any constraints that apply to this transaction.
Specify constraints to ensure that the transaction conforms to predefined criteria. This is useful if your integration does not directly collect all the transaction values (e.g. a session-based integration or a checkout integration).
Information about the payment plan constraints which apply for this transaction.
Specify payment plan constraints to restrict the available payment plan options for this transaction.
Integer
CONDITIONAL
The allowable number of deferral months for the payment plan.
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
Integer
CONDITIONAL
The allowable number of installments for the payment plan.
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
String
CONDITIONAL
The identifiers for the payment plans supported for this transaction.
If you wish to offer any payment plans to the payer, provide the plan identifiers in this field else pass it as empty.
See Payment Plans for the supported payment plans and their identifiers.
Data can consist of any characters
String
CONDITIONAL
A transient identifier for the request, that can be used to match the response to the request.
The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.
Data can consist of any characters
Details about credit card bill payments.
The details about the person who is requesting that you pay the credit card bill.
The payment sender's address.
String
CONDITIONAL
The city portion of the address.
Data can consist of any characters
Upper case alphabetic text
CONDITIONAL
The 3 letter ISO standard alpha country code of the address.
Data must consist of the characters A-Z
Alphanumeric + additional characters
CONDITIONAL
The post code or zip code of the address.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
String
CONDITIONAL
The three character ISO 3166-2 country subdivision code for the state or province of the address.
Data can consist of any characters
String
CONDITIONAL
The first line of the street address.
Data can consist of any characters
Digits
CONDITIONAL
Submit this field if the account identifier of the payment sender is a bank account number.
For a split payment where both a debit card and bank account were used, you must provide both the creditCardBillPayment.paymentSender.cardNumber and the creditCardBillPayment.paymentSender.bankAccountNumber field.
Data is a string that consists of the characters 0-9.
Digits
CONDITIONAL
Submit this field if the account identifier of the payment sender is a debit card number.
For a split payment where both a debit card and bank account were used, you must provide both the creditCardBillPayment.paymentSender.cardNumber and the creditCardBillPayment.paymentSender.bankAccountNumber field.
Data is a string that consists of the characters 0-9.
String
CONDITIONAL
The payment sender's first name.
Data can consist of any characters
String
CONDITIONAL
The payment sender's last name.
Data can consist of any characters
Information associated with the customer's account.
Information about the customer's account with you
Information about how you authenticated the payer.
A record that ties together a customer's account on your website or application with a card which they use, using a service such as Mastercard Identity Check Express (IDCX).
By performing payer authentication for that card, and recording that against the secured login, it is possible to achieve a frictionless payer authentication flow for future transactions by showing that they have securely logged in to the merchant using that account. To demonstrate this, you should provide the customer.account.authentication.data, customer.account.authentication.method and customer.account.authentication.time fields.
Enumeration
CONDITIONAL
Used to perform additional behaviour relating to the association between the customer account and their card.
Value must be a member of the following list. The values are case sensitive.
AUTHENTICATION
You are submitting a payment or non-payment Authentication request with evidence of strong customer authentication you have already performed to be validated against a previously created record, in order to obtain frictionless authentication for the payer.
REGISTRATION
You are submitting evidence of strong customer authentication performed by your website or application using a suitable, certified authentication mechanism, in order to record an association between this customer login and the 3DS authenticated cardholder.
String
CONDITIONAL
The data returned by an authentication service that you used to authenticate the customer when they logged on to your site/service.
For example, a FIDO token provided by a federated identity provider.
Data can consist of any characters
Enumeration
CONDITIONAL
The method you used to authenticate the payer.
Value must be a member of the following list. The values are case sensitive.
CUSTOMER_ACCOUNT_LOGIN
The merchant authenticated the payer using a credential system (for example,password) that they manage.
FEDERATED_IDENTITY_LOGIN
The merchant authenticated the payer using a federated identity management service such as Google or Facebook
FIDO_AUTHENTICATION
The merchant authenticated the payer using hardware, mobile, or biometrics based authentication that is compliant with FIDO Alliance specifications.
ISSUER_ACCOUNT_LOGIN
The merchant authenticated the payer using a credential system for example, password) managed by the issuer.
NONE
The merchant did not authenticate the payer.
THIRD_PARTY_ACCOUNT_LOGIN
The merchant authenticated the payer using a credential system managed by a third party.
DateTime
CONDITIONAL
The data and time you authenticated the payer using the method specified in customer.account.authentication.method.
You must provide the authentication time if you authenticated the payer.
An instant in time expressed in ISO8601 date + time format - "YYYY-MM-DDThh:mm:ss.SSSZ"
Information about the payer's historical activity related to their customer account with you.
Integer
CONDITIONAL
Number of times the account holder has tried to add or change their card over the last 24 hours.
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
Integer
CONDITIONAL
The number of transactions (successful and abandoned) that have been requested in the last year for all payment methods stored against this customer account.
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
Date
CONDITIONAL
The date the payer created an account with you.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
Information about the payer authentication performed for a previous transaction with you.
String
CONDITIONAL
The unique transaction identifier used by the issuer's Access Control Server (ACS) to identify the transaction.
If you are processing a recurring payment, then provide the transaction acsTransactionId for the transaction where the payer was authenticated.
Data can consist of any characters
Base64
CONDITIONAL
The authentication token obtained as the result of a previous authentication request.
Data is Base64 encoded
DateTime
CONDITIONAL
The date and time the payer was authenticated for the prior transaction.
If you are processing a recurring payment, then provide the time and date for the transaction where the payer was authenticated.
An instant in time expressed in ISO8601 date + time format - "YYYY-MM-DDThh:mm:ss.SSSZ"
String
CONDITIONAL
The transaction ID of a previous Authenticate Payer request on the order, which the gateway can retrieve and use instead of you providing the data explicitly in the customer.account.history.issuerAuthentication.authenticationToken, customer.account.history.issuerAuthentication.type and customer.account.history.issuerAuthentication.time and customer.account.history.issuerAuthentication.acsTransactionId fields.
You should provide this if you are performing an authentication request to obtain a new authentication token to replace one which is no longer valid due to age or details such as the amount of the transaction having changed.
Data can consist of any characters
Enumeration
CONDITIONAL
The method used to authenticate the payer for a prior transaction with you.
Value must be a member of the following list. The values are case sensitive.
3DS_FRICTIONLESS
3DS authentication was performed without payer interaction.
3DS_CHALLENGE
3DS authentication was performed and the payer was challenged for additional information.
ADDRESS_VERIFICATION
The issuer verifed the billing address provided by the payer. 3DS authentication was not used.
OTHER
The issuer verifed the payer using another method.
Date
CONDITIONAL
The date the payer's account with you was last updated.
For example, they changed address details or changed card details.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
Date
CONDITIONAL
The date the payer last changed the password for their account with you.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
Integer
CONDITIONAL
The number of transactions (successful and abandoned) that have been requested in the last 24 hours for all payment methods stored against this customer account.
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
Date
CONDITIONAL
The date you first shipped goods to the payer's shipping address provided in the shipping.address parameter group.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
Boolean
CONDITIONAL
Have you experienced suspicious or fraudulent activity on the account in the past.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
String
CONDITIONAL
Your identifier for the payer's account with you.
This should be an immutable identifier, rather than the customer's name, email or such data that could be changed by the customer.
Data can consist of any characters
Date
CONDITIONAL
The payer's date of birth.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
Email
CONDITIONAL
The email address of the customer.
The field format restriction ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
String
CONDITIONAL
The payer's first name.
Data can consist of any characters
Identification of the payer.
This information is used to identify the sender in account funding transactions.
Upper case alphabetic text
CONDITIONAL
The ISO 3166 three-letter country code of the issuer of the identification.
Data must consist of the characters A-Z
Enumeration
CONDITIONAL
The type of identification provided for the customer.
Value must be a member of the following list. The values are case sensitive.
ALIEN_REGISTRATION_NUMBER
The customer's identification type is an alien registration number issued by U.S. Citizenship and Immigration Services (USCIS) to immigrants who apply to live in the United States.
BUSINESS_TAX_ID
The customer's identification type is a business tax id which is assigned to the business entity by the tax department.
COMPANY_REGISTRATION_NUMBER
The customer's identification type is company registration number which is issued to the company at the time of its incorporation.
CUSTOMER_IDENTIFICATION
The customer's identification type is an unspecified form of customer identification through which the customer can identified and verified.
DATE_OF_BIRTH
The customer's identification type is date of birth.
DRIVERS_LICENSE
The customer's identification type is a driving license.
EMAIL
The customer's identification type is an email address.
GOVERNMENT_ISSUED
The customer's identification type is government issued.
INDIVIDUAL_TAX_ID
The customer's identification type is an individual tax id which is assigned to the individual by the tax department.
LAW_ENFORCEMENT_IDENTIFICATION
The customer's identification type is a law enforcement identification.
MILITARY_IDENTIFICATION
The customer's identification type is a military identification which is issued by the department of defense and military.
NATIONAL_IDENTIFICATION_CARD
The customer's identification type is a national identification card issued by the customer's country.
OTHER
The customer's identification type cannot be classified using any of the other categories. This is the default value.
PASSPORT
The customer's identification type is a passport.
PHONE_NUMBER
The customer's identification type is a phone number.
PROXY_IDENTIFICATION
The customer's identification type is proxy identification.
SOCIAL_SECURITY_NUMBER
The customer's identification type is a social security number issued by Social Security Administration (SSA) to U.S. citizens, permanent residents and eligible non-immigrant workers in United States.
TRAVEL_IDENTIFICATION
The customer's identification type is travel document other than a passport.
String
CONDITIONAL
The identification value/number for the type of identification provided in customer.identification.type.
Data can consist of any characters
String
CONDITIONAL
The payer's last or surname.
Data can consist of any characters
String
CONDITIONAL
The payer's middle name.
Data can consist of any characters
Telephone Number
CONDITIONAL
The payer's mobile phone or cell phone number in ITU-T E123 format, for example +1 607 1234 5678
The number consists of:
- '+'
- country code (1, 2 or 3 digits)
- 'space'
- national number ( which may embed single spaces characters for readability).
Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)
String
CONDITIONAL
An identifier for the payer assigned by a government authority.
For example, in Mexico this could be the CURP (Clave Única de Registro de Población), RFC (Registro Federal del Contribuyente), or INE (Instituto Nacional Electoral) number. In Brazil this could be the CPF (Cadastro de Pessoas Físicas) or CNPJ (Cadastro Nacional de Pessoas Jurídicas).
Data can consist of any characters
Telephone Number
CONDITIONAL
The payer's phone number in ITU-T E123 format, for example +1 607 1234 456
The number consists of:
- '+'
- country code (1, 2 or 3 digits)
- 'space'
- national number ( which may embed single spaces characters for readability).
Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)
String
CONDITIONAL
The tax registration identifier of the customer.
Data can consist of any characters
Information about the device used by the payer for this transaction.
String
CONDITIONAL
The telephone number captured by ANI (Automatic Number Identification) when the customer calls to place the order.
Data can consist of any characters
String
CONDITIONAL
The 2 digit ANI information identifier provided by the telephone company to indicate the call type, for example, cellular (61-63), toll free (24,25), etc.
Data can consist of any characters
String
CONDITIONAL
The User-Agent header of the browser the customer used to place the order.For example, MOZILLA/4.0 (COMPATIBLE; MSIE 5.0; WINDOWS 95)
You must provide a value in this field if you are performing 3-D Secure authentication of the payer and set authentication.channel = PAYER_BROWSER.
Data can consist of any characters
Detailed information about the payer's browser.
If you are using 3-D Secure authentication to authenticate the payer, then this information is used by the issuer's Access Control Server (ACS) to identify the capabilities of the payers browser so that it can render content appropriately when authenticating the payer.
You must provide values for fields in this parameter group if you are performing 3-D Secure authentication of the payer and set authentication.channel = PAYER_BROWSER.
Enumeration
CONDITIONAL
Dimensions of the challenge window (in width x height in pixels) displayed to the payer during 3D-Secure authentication.
This must be provided for authentication operations where authentication.channel is PAYER_BROWSER.
Value must be a member of the following list. The values are case sensitive.
250_X_400
390_X_400
500_X_600
600_X_400
FULL_SCREEN
String
CONDITIONAL
The content of the Accept request-header field as sent from the payer's browser.
This is used to determine which content types are supported by the browser.
This must be provided for authentication operations where authentication.channel is PAYER_BROWSER.
Data can consist of any characters
Integer
CONDITIONAL
The bit depth (in bits per pixel) of the color palette for displaying images.
You obtain this value from the screen.colorDepth property of the payer's browser.
This must be provided for authentication operations where authentication.channel is PAYER_BROWSER.
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
Boolean
CONDITIONAL
Indicates whether or not the payer's browser supports Java.
You obtain this value from the navigator.javaEnabled property of the payer's browser
This must be provided for authentication operations where authentication.channel is PAYER_BROWSER.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
Boolean
CONDITIONAL
Indicates whether or not the payer's browser supports JavaScript.
You can determine this by setting the relevant value in a form to false, and then attempting to update it to true using JavaScript.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
String
CONDITIONAL
The language supported for the payer's browser as defined in IETF BCP47.
You obtain this value from the navigator.language property of the payer's browser.
This must be provided for authentication operations where authentication.channel is PAYER_BROWSER.
Data can consist of any characters
Integer
CONDITIONAL
The total height of the payer's browser screen in pixels.
You obtain this value from the screen.height property of the payer's browser
This must be provided for authentication operations where authentication.channel is PAYER_BROWSER.
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
Integer
CONDITIONAL
The total width of the payer's browser screen in pixels.
You obtain this value from the screen.width property of the payer's browser
This must be provided for authentication operations where authentication.channel is PAYER_BROWSER.
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
Browser Time Zone Offset
CONDITIONAL
Time difference between UTC time and the Cardholder browser local time, in minutes.
The time zone offset is the difference, in minutes, between UTC and local time. Note that this means that the offset is positive if the local time zone is behind UTC and negative if it is ahead. For example, for time zone UTC+10:00 (Australian Eastern Standard Time, Vladivostok Time, Chamorro Standard Time), -600 would be presented.
This must be provided for authentication operations where authentication.channel is PAYER_BROWSER.
Browser time zone offset between -840 to +840.
String
CONDITIONAL
Information collected about a remote computing device for the purpose of providing a unique identifier for the device.
For example, session ID, blackbox ID.
Data can consist of any characters
String
CONDITIONAL
The name of the server to which the customer is connected.
Data can consist of any characters
String
CONDITIONAL
The IP address of the device used by the payer, in IPv4 nnn.nnn.nnn.nnn format.
You can provide the IP address in IPv6 format as defined in RFC4291.
IPv6 address will only be used in EMV 3DS authentication. Supplied IPv6 address will not be used for any other purposes.
Data can consist of any characters
String
CONDITIONAL
The mobile phone manufacturer's identifier for the model of the mobile device used to initiate the payment.
Data can consist of any characters
Enumeration
CONDITIONAL
The type of disbursement used for this transaction.
If your Merchant Category Code is 7995 (Gambling Transactions) and you are paying out gaming winnings, set the value to GAMING_WINNINGS. If your Merchant Category Code is 6536 (MoneySend Intracountry) and you are paying a credit card bill, set the value to CREDIT_CARD_BILL_PAYMENT and provide the payment sender details.
Value must be a member of the following list. The values are case sensitive.
CREDIT_CARD_BILL_PAYMENT
Indicates that you are paying a credit card bill.
GAMING_WINNINGS
Indicates that you are paying out gaming winnings to a payer.
Additional information about the external token repository you are configured with.
These fields are MANDATORY for MerchantLink merchants and must not contain sensitive data.
String
CONDITIONAL
Provide the site code required to save card details against a token.
For example: '{"siteCode":"BNE"}'.
Data can consist of any characters
Enumeration
CONDITIONAL
The interface through which the transaction is submitted to the gateway.
Value must be a member of the following list. The values are case sensitive.
AUTO
The transaction was automatically generated by the gateway. For example, a Capture transaction for Auto-Capture or an order reversal transaction for risk rejected orders.
BATCH
The transaction was submitted as part of a merchant batch. Batches can either be uploaded via Batch or via Merchant Administration.
CHECKOUT_VIA_PAYMENT_LINK
The transaction was created via checkout. The payer was redirected to checkout by clicking on a payment link.
CHECKOUT_VIA_WEBSITE
The transaction was created via checkout. The payer was redirected from your website to checkout.
MERCHANT_ADMINISTRATION
The transaction was initiated in Merchant Administration.
MERCHANT_MANAGER
The transaction was initiated in Merchant Manager.
SERVICE_PROVIDER_API
The transaction was reported by an acquirer or alternate payment provider.
WEB_SERVICES_API
The transaction was submitted via Web Services API.
String
CONDITIONAL
The person who initiated this transaction.
This field is automatically populated by the gateway if the transaction was created via Merchant Administration (gatewayEntryPoint=MERCHANT_ADMINISTRATION) or Merchant Manager (MERCHANT_MANAGER). In this case this is the name that the person used to log in to Merchant Administration or Merchant Manager respectively.
Data can consist of any characters
Information about the API operations that you will use to submit the financial transaction requests.
Enumeration
CONDITIONAL
Indicates operation that payer wish to perform to submit the financial transaction requests.
Value must be a member of the following list. The values are case sensitive.
AUTHORIZE
Request for the Payment Configuration interaction to check AUTHORIZE transaction for the payment is supported by the acquirer.
NONE
Payment Configuration interaction will collect the payment details from the payer and securely store them against the Payment Options Inquiry. No operation will be performed after the payer interaction.
PURCHASE
Request for the Payment Configuration interaction to check PURCHASE transaction for the payment is supported by the acquirer.
VERIFY
Request for the Payment Options Inquiry to verify the payer's account.Request for the Payment Options Inquiry interaction to check Verify transaction for the payment is supported by the acquirer.
String
CONDITIONAL
Tyro might have configured your merchant profile to support several lines of business.
Each line of business can have different payment parameters, such as bank account, supported cards or such.
For example, lineOfBusiness = TICKET_SALES can have a different bank account from lineOfBusiness = MERCHANDISING. One line of business on your profile might be "null". To use that, do not provide the lineOfBusiness field.
Data can consist of any characters except space
String
CONDITIONAL
A language identifier or IETF language tag to control the language of the payment interaction with the payer (e.g. en_US, es, fr-CA).
By default, the language is determined from your configuration. Supply a value for this field only if you wish to override the default behavior. If the language you specify is not supported by the gateway, the payment is displayed in the best matching language.
See Dynamic Currency Conversion for more detail.
Data must be a language identifier or IETF language tag
Alphanumeric + additional characters
ALWAYS PROVIDED
The unique identifier issued to you by your payment provider.
This identifier can be up to 12 characters in length.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_'
Information about the order associated with this transaction.
Boolean
CONDITIONAL
Indicates whether you will accept a payment less than order.amount, e.g. when using a gift card.
If not set or set to FALSE, and the full amount is not available, the transaction will be rejected.
Unless you have been advised by tyro that the gateway supports partial approvals for your acquirer, you can ignore this field.
If the gateway supports partial approvals for your acquirer you must set this field to TRUE else the transaction is rejected by the gateway.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
Decimal
CONDITIONAL
The total amount for the order. This is the net amount plus any merchant charge amounts.If you provide any sub-total amounts, then the sum of these amounts (order.itemAmount, order.taxAmount, order.shippingAndHandlingAmount, order.cashbackAmount, order.gratuityAmount, order.merchantCharge.amount and order.dutyAmount), minus the order.discountAmount must equal the net amount.
The value of this field in the response is zero if payer funds are not transferred.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Boolean
CONDITIONAL
Set this flag if the transaction is a manual cash disbursement transaction, i.e. cash is disbursed upon the acceptance of a card by a financial institution teller.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
Decimal
CONDITIONAL
The amount the payer has chosen to receive as cash in addition to the amount they are paying for the goods or services they are purchasing from you.
The cash back amount is included in the total amount of the order you provide in order.amount.
This field corresponds to EMV tag 9F03
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Enumeration
CONDITIONAL
Indicates if you expect to capture the full order amount for which you are requesting authorization.
If you do not provide a value for order.certainty the default configured for you by tyro will be used. The value provided in the response shows the value the gateway sent to the acquirer
Value must be a member of the following list. The values are case sensitive.
ESTIMATED
The amount authorized is an estimate of the amount that will be captured. It is possible that the amount captured will be less, or might not be captured at all.
FINAL
The full authorized amount is expected to be captured within the mandated time. The order will only be cancelled in exceptional circumstances (for example, the payer cancelled their purchase).
Upper case alphabetic text
CONDITIONAL
The currency of the order expressed as an ISO 4217 alpha code, e.g. USD.
Data must consist of the characters A-Z
String
CONDITIONAL
Information about this order that is of interest to you.
For example order.custom.X, where 'X' is defined by you and must be less than 100 characters from the set A-Z, a-z, 0-9. For example, order.custom.salesRegion. You can specify up to 50 such fields. They are not sent to acquirers.
Data can consist of any characters
String
CONDITIONAL
A note from the payer about this order.
Data can consist of any characters
Date
CONDITIONAL
The date the payer placed the order.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd.
ASCII Text
CONDITIONAL
The payer's own reference for the order.
This reference may assist the payer to identify the order in their system. For example, a purchase order number, project identifier, or cost center.
Data consists of ASCII characters
String
CONDITIONAL
Short textual description of the contents of the order.
Data can consist of any characters
Information about a price reduction you have applied to the order.
For example, you may apply discounts for trade, employees, bulk purchase, or a sales promotion.
Decimal
CONDITIONAL
The total amount of the discount you have applied to the order.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
CONDITIONAL
The code you use to identify the reason for the discount.
Data can consist of any characters
String
CONDITIONAL
A description of your reason for the discount.
Data can consist of any characters
Decimal
CONDITIONAL
The duty amount (also known as customs tax, tariff or dues) for the order.
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
Digits
CONDITIONAL
This field only applies if you intend to receive the payer's funds in several Capture operations.
You must provide this value where you want the gateway to automatically reverse the outstanding Authorization amount you do not intend to capture. Note that this requires your merchant profile to be configured accordingly. Contact tyro if you are unsure about your configuration.
The field indicates the total number of Capture requests you intend to submit for an order. For example, if you intend to deliver the goods in two shipments and will capture part of the total authorized amount when you make each shipment, set the value of this field to 2.
If the value equals or drops below the actual number of successful Captures, then the gateway will prevent further Captures and void the outstanding Authorization amount (depending on your merchant profile configuration). If you are unsure of the number of Captures, set the value to 99, and to one on your last Capture.
If you do not provided a value for this field, but had previously provided one, the previous value is applied. For example, if you provide a value 2 on the first Capture for the order and then submit a second Capture without a value, the gateway assumes that the value is still 2.
Data is a number between 1 and 99 represented as a string.
Decimal
CONDITIONAL
The amount the payer has chosen to provide as a gratuity or tip in addition to the amount they are paying for the goods or services they are purchasing from you.
The gratuity amount is included in the total amount of the order you provide in order.amount.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
CONDITIONAL
A unique identifier for this order to distinguish it from any other order you create.
Use this identifier when referring to this order in subsequent transactions and in retrieval operations. This value must be unique for every order you create using your merchant profile.
Data can consist of any characters
Enumeration
CONDITIONAL
This field is used to classify merchant initiated payments which are submitted in the context of certain industry practices.
Use this field to indicate the reason for that industry practice payment.
A merchant initiated industry practice transaction must also contain the 'scheme transaction Id' from the associated cardholder initiated transaction.
You can provide the referenceOrderId of the relevant cardholder initiated transaction and the gateway will include the 'scheme transaction Id' on the industry practice transaction. For example, when you submit a 'delayed charge', you should provide the referenceOrderId of the cardholder-initiated transaction that resulted in the delayed charge.
Alternatively, you can provide the 'scheme transaction Id' of the cardholder initiated transaction in the industry practice transaction using the field transaction.acquirer.traceId.
You must have obtained the payer's consent prior to submitting industry practice transactions.
Value must be a member of the following list. The values are case sensitive.
DELAYED_CHARGE
An additional payment processed in accordance with your terms and conditions after the original payment has been processed. For example, hotel mini bar charge after the payer has checked out or damage to a rental car.
NO_SHOW_PENALTY
A penalty charged in accordance with your charge cancellation policy the payer cancels or fails to show for the booking.
PARTIAL_SHIPMENT
A shipment where merchant decides to ship the goods from the same order in multiple shipments due to various reasons like goods availability, involvement of multiple suppliers for goods etc.
String
CONDITIONAL
The invoice number you issued for this order.
Data can consist of any characters
Information about the items the payer purchases with the order.
String
CONDITIONAL
The brand of the item.
For example, Dell.
Data can consist of any characters
String
CONDITIONAL
Your category for the item.
Data can consist of any characters
String
CONDITIONAL
Description for the item with information such as size, color, etc.
For example, 'Color:Red, Size:M'
Data can consist of any characters
Only use this parameter group to provide additional line item details required for a better interchange rate for Purchasing Cards, Business and/or Corporate Cards (Level 3).
Check with tyro if Level 3 data is supported for your acquirer.
JSON Text
CONDITIONAL
Use this field to provide line item details that your acquirer requires you to provide.
Data must be provided in JSON format using the record name and field name (separated by a comma) to identify the value provided. Contact tyro for details about the supported fields including the field definitions.
Data is valid Json Format
Digits
CONDITIONAL
A code describing a commodity or a group of commodities pertaining to goods classification.
Data is a number between 1 and 9999999999999999 represented as a string.
Information about the taxes per line item.
Decimal
CONDITIONAL
The tax amount for the tax type defined in order.item[n].detail.tax[m].type for the item.
Note that the tax amount provided must reflect the tax amount applied before a discount was applied.
Data is a string that consists of the characters 0-9, '.' and '-' and represents a valid decimal number.
Decimal
CONDITIONAL
The tax rate (percentage) applied to the item for the tax type defined in order.item[n].detail.tax[m].type.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
CONDITIONAL
The tax type for which the amount specified under order.item[n].detail.tax[m].amount has been paid for this item.
The correct value as used by your acquirer may have to be provided. Contact tyro for details.
Data can consist of any characters
Decimal
CONDITIONAL
The discount rate (percentage) applied to this item.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Decimal
CONDITIONAL
The tax rate (percentage) of the tax charged for this item.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
CONDITIONAL
The type of tax charged for this item.
The correct value as used by your acquirer may have to be provided. Contact tyro for details.
Data can consist of any characters
Digits
CONDITIONAL
The United Nations Standard Products and Services Code (UNSPSC) for the item.
Data is a number between 1 and 9999999999999999 represented as a string.
Digits
CONDITIONAL
The Universal Product Code (UPC) for the item.
Data is a number between 1 and 9999999999999999 represented as a string.
URI
CONDITIONAL
The URL of the item image for display to the payer during the payment interaction.For best results, use images in JPEG or PNG formats.The recommended size is 144 pixels width and 144 pixels height.
The image will be cropped at this height and width.
Data must be an absolute URI conforming to the URI syntax published by IETF RFC 2396. The URI must be one of the following schemes : https
Enumeration
CONDITIONAL
Provide the industry category to send this line item to your acquirer for specialized processing as industry data.
Such processing might have legal obligations, which are your responsibility. Do not provide an industry category, unless you are certain it applies to you, and is accepted by your acquirer.
We support the following industry standard processing:US health care processing using the IIAS standard.The supported values for this field are:HEALTHCARE_VISION, HEALTHCARE_DENTAL, HEALTHCARE_PRESCRIPTION, HEALTHCARE_OTHERWe formulate an IIAS message by summing the amounts of all the line items with the same industry category. The amount of a line item is computed as:(order.item.unitPrice + order.item.tax) * order.item.quantity
Value must be a member of the following list. The values are case sensitive.
HEALTHCARE_DENTAL
HEALTHCARE_OTHER
HEALTHCARE_PRESCRIPTION
HEALTHCARE_VISION
String
CONDITIONAL
A short name describing the item.
Data can consist of any characters
Decimal
CONDITIONAL
The quantity of the item.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number greater than zero.
String
CONDITIONAL
The serial number of the item.
Data can consist of any characters
String
CONDITIONAL
A list of serial numbers for this item.
Provide the serial numbers for the item that you have registered with the payment plan service provider for payment plan offers.
Data can consist of any characters
String
CONDITIONAL
The SKU (Stock Keeping Unit) or the item identifier for this item.
Data can consist of any characters
Decimal
CONDITIONAL
The discount amount applied to this item.
Data is a string that consists of the characters 0-9, '.' and '-' and represents a valid decimal number.
String
CONDITIONAL
The unit of measure used for the item quantity.
The correct value as used by your acquirer may have to be provided. Contact tyro for details.
Data can consist of any characters
Decimal
CONDITIONAL
The cost price for the item.
This amount is multiplied with the item quantity (item.quantity) to determine the total amount for this item (item.amount). This amount does not include the tax amount and/or discount amount applicable to this item.
Data is a string that consists of the characters 0-9, '.' and '-' and represents a valid decimal number.
Decimal
CONDITIONAL
The tax amount for the item.
This amount is multiplied with the item quantity (item.quantity) to determine the total tax amount for this item.
Data is a string that consists of the characters 0-9, '.' and '-' and represents a valid decimal number.
Decimal
CONDITIONAL
The total item amount for the order.
If you do not provide this value but provide line item data, then this amount is calculated as the sum of the item.quantity times the item.unitPrice for all the line items (total item amount).
If you provide both this value and line item data, then the order.itemAmount MUST equal the total item amount.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Information about the items the payer purchases with the order.
String
CONDITIONAL
A short name describing the item.
Data can consist of any characters
Decimal
CONDITIONAL
The quantity of the item.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number greater than zero.
String
CONDITIONAL
The serial number of the item.
Data can consist of any characters
String
CONDITIONAL
The SKU (Stock Keeping Unit) or the item identifier for this item.
Data can consist of any characters
Decimal
CONDITIONAL
The cost price for the item.
This amount is multiplied with the item quantity (item.quantity) to determine the total amount for this item (item.amount). This amount does not include the tax amount and/or discount amount applicable to this item.
Data is a string that consists of the characters 0-9, '.' and '-' and represents a valid decimal number.
String
CONDITIONAL
Your tax registration identifier provided by the Local/State/Province tax authority.
If you are a Canadian merchant, use this field to provide your Tax Registration ID for paying Provincial Sales Tax (PST).
Data can consist of any characters
Use this parameter group to provide additional information if you are a marketplace.You are considered a marketplace if you operate an electronic commerce website or mobile application that brings together payers and retailers and you are selling the goods or services on behalf of the retailer.In this case, the card schemes may require you to register with them as a marketplace and assign you a Marketplace ID.
You should provide this identifier to tyro so that the gateway can automatically include it in all transaction messages to your acquirer.
Enumeration
CONDITIONAL
Provide information about the location of the retailers for goods or services included in this order.Where a retailer is located in a country different from your country, they are considered a foreign retailer, otherwise they are considered a domestic retailer.
Value must be a member of the following list. The values are case sensitive.
DOMESTIC_ONLY
The order only contains items from domestic retailers.
FOREIGN_AND_DOMESTIC
The order contains items from both foreign and domestic retailers.
FOREIGN_ONLY
The order only contains items from foreign retailers.
Digits
CONDITIONAL
A 4-digit code used to classify your business by the type of goods or services it offers.
This is also known as the Merchant Category Code (MCC).
You only need to provide the MCC if you want to override the default value configured for your acquirer link.The value you provide must match one of those configured by tyro.
Data is a string that consists of the characters 0-9.
Information about additional fees that you are charging the payer for processing the payment for this order, for example, a surcharge.
Decimal
CONDITIONAL
The amount of the additional fee that you are charging the payer.
If you provide a charge amount, you must include it in the total amount for the order.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Enumeration
CONDITIONAL
The type of the additional fee that you are charging the payer.
Value must be a member of the following list. The values are case sensitive.
SURCHARGE
A fee that covers your cost of accepting accepting a payment method.
Digits
CONDITIONAL
The code that represents a partnership agreement, between you and the issuer.
Data is a string that consists of the characters 0-9.
Decimal
CONDITIONAL
The amount payable for the order before merchant charge amount is applied.
If you specify a net amount the gateway will calculate the merchant charge amount for you based on the charge type (order.merchantCharge.type) provided in the request. Alternatively, you can specify the merchant charge amount (order.merchantCharge.amount) yourself.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Url
CONDITIONAL
The URL to which the gateway will send Webhook notifications when an order is created or updated.
To receive notifications at this URL, you must enable Webhook notifications in Merchant Administration. Ensure the URL is HTTPS
Ensure that this is a valid URL according to RFC 1738.
String
CONDITIONAL
Your identifier for the part of your organization that is responsible for the order.
You might provide this data when you want to track the accountability for the order. For example, store number, sales region, branch, or profit center
Data can consist of any characters
Enumeration
CONDITIONAL
Indicates the purchase of specific types of goods or services.
You must provide a value if your Merchant Category Code (MCC) is one of the following:
6051 (Quasi Cash – Merchant or Non-Financial Institutions – Foreign Currency, Non-Fiat Currency) and this transaction is for the purchase of cryptocurrency. Set the value to CRYPTOCURRENCY.
6211 (Securities – Brokers/Dealers) and this transaction is for the purchase of high-risk securities. Set the value to HIGH_RISK_SECURITIES.
6012 (Merchandise and Services—Customer Financial Institutions) or 6051 (Non-Financial Institutions – Foreign Currency, Non-Fiat Currency) and this transaction is for debt repayment. Set the value to DEBT_REPAYMENT.
If the transaction pulls money from an account for the purpose of crediting another account you must set purchase type to ACCOUNT_FUNDING.
You may set purchase type to OTHER for any other type of payment.
Value must be a member of the following list. The values are case sensitive.
ACCOUNT_FUNDING
The transaction pulls money from an account for the purpose of crediting another account. You may be required to provide additional details about the account funding transaction in the accountFunding parameter group.
CRYPTOCURRENCY
The transaction is for the purchase of a cryptocurrency.
DEBT_REPAYMENT
You may be required to provide additional details about the debt repayment in the debtRepayment parameter group.
HIGH_RISK_SECURITIES
The transaction is for the purchase of high-risk securities.
OTHER
Use this value if the purchase type for the transaction does not fit in any of the other categories.
String
CONDITIONAL
The identifier of the order.
For example, a shopping cart number, an order number, or an invoice number.
Data can consist of any characters
String
CONDITIONAL
The name of the person who requested the goods or services.
Data can consist of any characters
Information about reward points earned using a card enrolled in a rewards program that are being redeemed as full or part payment for this order.
Decimal
CONDITIONAL
The amount that the payer has chosen to pay by redeeming reward points earned using a card enrolled in a rewards program for full or part payment for this purchase.
The reward amount is included in the total amount of the order you provide in order.amount.You must provide this value if the rewards program supports a payer-nominated amount (availableBalance.reward.payerNominatedAmount returned from the Balance Inquiry operation has a value of 'true').
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Alphanumeric + additional characters
CONDITIONAL
An identifier generated by the gateway when you have requested the balance available for a credit or debit card.
The presence of this field indicates that rewards are to be redeemed.The gateway will use the details stored against this identifier when authorizing the payment with your acquirer.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '%', '.', '='
Decimal
CONDITIONAL
The total shipping and handling amount for the order, including taxes on the shipping and/or handling.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Decimal
CONDITIONAL
The tax amount levied on the shipping and handling amount for the order.
This amount is included in the shipping and handling amount provided in field order.shippingAndHandlingAmount.
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
Decimal
CONDITIONAL
The tax rate applied to the shipping and handling amount for the order to determine the shipping and handling tax amount.
For a tax rate of 2.5% provide 0.025.
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
Contact information provided by you for printing on payer's account statements.
Descriptor address of the merchant.
String
CONDITIONAL
The city portion of the address.
Data can consist of any characters
String
CONDITIONAL
The name of the company associated with this address.
Data can consist of any characters
Upper case alphabetic text
CONDITIONAL
The 3 letter ISO standard alpha country code of the address.
Data must consist of the characters A-Z
Alphanumeric + additional characters
CONDITIONAL
The post code or zip code of the address.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
String
CONDITIONAL
The state or province code of the address.
For an address in the United States provide the 2-letter ISO 3166-2 state code. For US military bases provide one of AE, AA, AP.
For an address in Canada provide the 2-letter ISO 3166-2 province code.
Data can consist of any characters
String
CONDITIONAL
The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Data can consist of any characters
String
CONDITIONAL
The second line of the address (if provided).
Data can consist of any characters
String
CONDITIONAL
Descriptor name of the merchant.
Data can consist of any characters
String
CONDITIONAL
Descriptor phone number of the merchant's business.
Data can consist of any characters
Url
CONDITIONAL
The URL of the merchant's descriptor website.
Ensure that this is a valid URL according to RFC 1738.
Provide these parameters if you are a payment aggregator or facilitator and process payments on behalf of other merchants.
These merchants are referred to as your sub-merchants.
The sub-merchant's details you provide may be displayed on the payer's cardholder statement.
Note that your acquirer may require you to register with the card scheme(s) before allowing you to submit sub-merchant details with a transaction.
This data must be on the initial transaction of an order, subsequent transactions with sub-merchant will be rejected.
Note: If you are requesting payer authentication using 3-D Secure Version 2 then you must provide values for order.subMerchant.address.country and order.subMerchant.bankIndustryCode.
The sub-merchant's address.
String
CONDITIONAL
The city portion of the address.
Data can consist of any characters
String
CONDITIONAL
The name of the company associated with this address.
Data can consist of any characters
Upper case alphabetic text
CONDITIONAL
The 3 letter ISO standard alpha country code of the address.
Data must consist of the characters A-Z
Alphanumeric + additional characters
CONDITIONAL
The post code or zip code of the address.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
String
CONDITIONAL
The state or province of the address.
Data can consist of any characters
String
CONDITIONAL
The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Data can consist of any characters
String
CONDITIONAL
The second line of the address (if provided).
Data can consist of any characters
Information about the sub-merchant's registration to use a payer authentication protocol.
For example, using 3-D Secure authentication.
Information about the sub-merchant's registration to use 3-D Secure authentication version 2.
These details are used to identify the sub-merchant to the card scheme's directory server.
String
CONDITIONAL
The unique identifier assigned to the merchant by the card scheme directory server when the merchant registered to use 3-D Secure authentication version 2 with their acquirer.
For American Express and UnionPay if it is provided it will be used otherwise it will be generated by the gateway. This identifier should not be provided for other supported authentication schemes, as it will be generated by the gateway.
Data can consist of any characters
String
CONDITIONAL
The unique name assigned to the merchant by the card scheme directory server when the merchant registered to use 3-D Secure authentication version 2 with their acquirer.
For American Express and UnionPay if it is provided it will be used otherwise it will be generated by the gateway. This name should not be provided for other supported authentication schemes, as it will be generated by the gateway.
Data can consist of any characters
Enumeration
CONDITIONAL
The protocol used for payer authentication.
Value must be a member of the following list. The values are case sensitive.
AMEX_SAFEKEY
American Express SafeKey EMV 3DS authentication
DINERS_PROTECTBUY
Diners ProtectBuy EMV 3DS authentication
FASTR_BY_CB
Carte Bancaire FAST'R by CB using EMV 3DS authentication
JCB_JSECURE
JCB J/Secure using EMV 3DS authentication
UNIONPAY
UnionPay EMV 3DS authentication
VERIFIED_BY_VISA
Visa Verified by Visa EMV 3DS authentication
Digits
CONDITIONAL
Code used by acquirer to describe the business or industry the sub-merchant operates in.
You must provide a value if you want the gateway to perform 3-D Secure Version 2 authentication of the payer.
Data is a string that consists of the characters 0-9.
Telephone Number
CONDITIONAL
Only provide this field if you have received a notification from the scheme that either you or the sub-merchant has a high number of disputes.
In this case, provide a phone number that payers can use to contact the sub-merchant in case of a dispute. Where applicable, the issuer may display this phone number on the cardholder statement. The phone number must be provided in ITU-T E123 format.
Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)
Email
CONDITIONAL
The sub-merchant's email address.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
Upper case alphabetic text
CONDITIONAL
Only provide this field if the sub merchant is a government owned or controlled merchant.
A sub merchant is considered a government owned or controlled entity (government controlled merchant) if 50% or more of the sub merchant is owned by the government. Provide the ISO 3166 three-letter country code of the government country where this differs from the sub merchant's physical location country.
Data must consist of the characters A-Z
Alphanumeric + additional characters
CONDITIONAL
Your identifier for the sub-merchant.
You can use this identifier in searches and reports in the gateway.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '.'
String
CONDITIONAL
If the sub merchant is a marketplace, provide the marketplace ID assigned to them by Visa.
A sub merchant is considered a marketplace if they operate a platform (online commerce website or mobile application) where retailers can sell goods and services.
Data can consist of any characters
String
CONDITIONAL
The sub-merchant's phone number
Data can consist of any characters
String
CONDITIONAL
The legal name of the sub-merchant.
Data can consist of any characters
String
CONDITIONAL
The trading name of the sub-merchant, also known as doing business as (DBA), operating as or trading as.
For MasterCard transactions the name must not exceed 21 characters. For American Express transactions the name must not exceed 27 characters (or 36 characters including the aggregator name). The trading name may be displayed on the payer's cardholder statement. Therefore if you need to shorten it, use an abbreviation that will be meaningful to the payer when displayed on their statement.
Data can consist of any characters
Url
CONDITIONAL
The URL of the sub-merchant's website.
Ensure that this is a valid URL according to RFC 1738.
Information about orders for items not yet available (pre-order) or for items previously purchased (reorder).
Boolean
CONDITIONAL
Indicates that the purchase includes merchandise with a future availability or release date.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
Date
CONDITIONAL
The date that preordered items are expected to be available.
Provide this field if the payer is ordering items before you have them available for purchase.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
Boolean
CONDITIONAL
Indicates that the purchase includes merchandise that the payer has previously ordered.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
Use this parameter group to provide a breakdown of tax types, amount per tax type, and rate per tax type included in order.taxAmount.
Decimal
CONDITIONAL
The tax amount included in this order for the tax type.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Decimal
CONDITIONAL
The tax rate (percentage) used to determine the tax amount included in this order for the tax type.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
CONDITIONAL
The type of tax included in the order amount.
The correct value as used by your acquirer may have to be provided. Contact tyro for details.
Data can consist of any characters
Decimal
CONDITIONAL
The total tax amount for the order.
If you do not provide this value but provide line item data, then this amount is calculated as the sum of the item.quantity times the item.unitTaxAmount for all the line items (total tax amount).
If you provide both this value and line item data, then the order.taxAmount MUST equal the total tax amount.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
CONDITIONAL
Your tax registration identifier provided by the Federal/National tax authority (for example, federal tax identification number, ABN).
If you are a Canadian merchant, use this field to provide your Tax Registration ID for paying Harmonized Sales Tax (HST) or Goods and Services Tax (GST) collected by the Canada Revenue Agency.
Data can consist of any characters
Enumeration
CONDITIONAL
Indicates your tax status for this order.
Value must be a member of the following list. The values are case sensitive.
EXEMPT
Indicates that you are exempt from tax.
NOT_EXEMPT
Indicates that you are not exempt from tax.
NOT_PROVIDED
Indicates that you are not providing information about being exempt from tax.
Information relevant for Transaction Filtering.
Allows you to provide the Address Verification Service (AVS) Response Code Transaction Filtering rules to be applied to the transactions for this order.
If provided, these rules override the AVS Response Code Transaction Filtering rules you have configured in Merchant Administration.
Enumeration
CONDITIONAL
The action to be performed for the Address Verification Service (AVS) Response Code.
Value must be a member of the following list. The values are case sensitive.
NO_ACTION
No action should be taken by the gateway.
REJECT
The gateway must reject the transaction.
REVIEW
The gateway must mark this transaction as requiring a review.
Enumeration
CONDITIONAL
The Address Verification Service (AVS) Response Code for which you are defining the rule.
Value must be a member of the following list. The values are case sensitive.
ADDRESS_MATCH
Street address matched
ADDRESS_ZIP_MATCH
Street address and zip/postcode were matched
NAME_ADDRESS_MATCH
Card holder name and street address matched
NAME_MATCH
Card holder name matched
NAME_ZIP_MATCH
Card holder name and zip/postcode matched
NOT_AVAILABLE
No data available from issuer or AVS data not supported for transaction
NOT_REQUESTED
AVS not requested
NOT_VERIFIED
AVS could not be verified for an international transaction
NO_MATCH
No match
SERVICE_NOT_AVAILABLE_RETRY
Issuer system is unavailable. Retry can be attempted
SERVICE_NOT_SUPPORTED
Service currently not supported by acquirer or merchant
ZIP_MATCH
Zip/postcode matched. Street address not matched
Information about payments that transfer money to another store of value, such as a gift card or gaming chips.
Enumeration
CONDITIONAL
The type of value store to which money is being transferred.
The default value is NOT_A_TRANSFER.
Value must be a member of the following list. The values are case sensitive.
ACCOUNT_FUNDING
Payment to add funds to the payer's account with the merchant. These funds can be used for future purchases.
NOT_A_TRANSFER
This payment is not for the purpose of transferring money to another store of value. It is a payment for goods or services.
PREPAID_LOAD
Payment to add funds to a prepaid card or gift card.
QUASI_CASH_TRANSACTION
Payment for items that are directly convertible to cash. For example, money orders, casino gaming chips, or traveller's checks.
Decimal
CONDITIONAL
The amount of money being transferred, in units of order.valueTransfer.currency.
The default value is order.amount
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Upper case alphabetic text
CONDITIONAL
The currency of the store.
If the money is being transferred to multiple currencies, then use the currency of the highest transferred value.
The default value is order.currency.
Data must consist of the characters A-Z
Integer
CONDITIONAL
The number of prepaid or gift card being purchased.
The default value is one when you set order.valueTransfer.accountType = PREPAID_LOAD. For all other values of order.valueTransfer.accountType the default is zero.
A number comprising the digits 0-9, having at least one digit. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger.)
String
CONDITIONAL
The wallet indicator as returned by the wallet provider.
Data can consist of any characters
Enumeration
CONDITIONAL
Details about the source of the payment details used for digital payment methods.
Provide this value when you process payments for:
- • Device payment methods such as Apple Pay, Android Pay, Samsung Pay, or Google Pay.
- • Digital wallets such as Secure Remote Commerce (Click to Pay).
Value must be a member of the following list. The values are case sensitive.
APPLE_PAY
Apple Pay mobile wallet provider.
CHASE_PAY
Chase Pay wallet provider.
GOOGLE_PAY
Google Pay mobile wallet provider.
SAMSUNG_PAY
Samsung Pay mobile wallet provider.
SECURE_REMOTE_COMMERCE
Secure Remote Commerce (SRC) wallet provider.
String
CONDITIONAL
Indicates the result of payer authentication.
Data can consist of any characters
String
CONDITIONAL
Indicates the verification method used to authenticate the payer.
Data can consist of any characters
String
CONDITIONAL
If, when integrating with the gateway, you are using a solution (e.g. a shopping cart or e-commerce solution) provided, supported or certified by tyro, enter the solution ID issued by tyro here.
If tyro has not provided you with a solution ID, you should ignore this field.
Data can consist of any characters
Enumeration
CONDITIONAL
The payment method the payer wishes to use to pay for this order.
Value must be a member of the following list. The values are case sensitive.
ACH
ALIPAY
BANCANET
BANCONTACT
BLIK
BOLETO_BANCARIO
BROWSER_PAYMENT
CARD
DIRECT_DEBIT_CANADA
ENETS
EPS_UEBERWEISUNG
GIFT_CARD
GIROPAY
GRABPAY
IDEAL
KLARNA_FINANCING
KLARNA_PAY_LATER
KLARNA_PAY_NOW
MERCADO_PAGO_CHECKOUT
MULTIBANCO
OPEN_BANKING_BANK_TRANSFER
OXXO
PAYCONIQ
PAYPAL
PAYSAFECARD
PAYU
PBBA
POLI
PRZELEWY24
SEPA
SOFORT
TRUSTLY
String
CONDITIONAL
This is the reference to an order previously submitted by you to the gateway.
It is applicable to the following scenarios.
Tokenization requests:
Identifier for the order which will be used to generate a gateway token. The gateway will attempt tokenization of payment credentials linked to the order ID.
The order identifier provided in this field must be linked to a successfully processed order which has card (FPAN / DPAN) as the payment method.
When providing this field, you must not provide card details in the sourceOfFunds.provided.card parameter group.
Payment transactions:
When submitting:
- an industry practice payment, this is the reference to the initial cardholder-initiated transaction.
- a resubmission transaction, this is the reference to the order which is being resubmitted.
Data can consist of any characters
Container for fields that control the response returned for the request.
String
CONDITIONAL
Indicates how sensitive data is returned in the response.
Data can consist of any characters
Information relevant to risk assessment.
Enumeration
CONDITIONAL
The risk rules you wish to bypass when performing risk assessment for an order.
Value must be a member of the following list. The values are case sensitive.
ALL
String
CONDITIONAL
Additional data passed to third-party risk assessment providers.
This field is only relevant if you use a third-party risk assessment provider, and you have agreed with them the values to provide (maximum 100 characters in a field name from the set A-Z, a-z, 0-9, maximum 4kB in length of values across all custom risk fields). An example might be:
Field: risk.custom.headOfficeLocation
Value: London UK
Data can consist of any characters
Details about the recipient of the payment and the destination account for the payment.
Your acquirer may require you to provide these details if you are a financial institution (Merchant Category Code 6012) submitting a transaction for a person paying off outstanding debts. Otherwise, do not provide these data elements.
String
CONDITIONAL
The account identifier for the payment recipient's account.
For payments into a card account provide the card number. For payments into other accounts (for example a bank account) provide the account number. The value provided will be returned masked in the response.
Data can consist of any characters
Date
CONDITIONAL
The date of birth of the primary payment recipient in yyyy-mm-dd format.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
String
CONDITIONAL
Last name of the primary payment recipient.
Data can consist of any characters
String
CONDITIONAL
Postcode of the primary payment recipient.
Data can consist of any characters
Enumeration
CONDITIONAL
The mode used to create a gateway token and obtain a scheme token from the token service provider.
You only need to specify the scheme token provisioning mode if you want to override the default value configured for your token repository.
You can refer to the schemeToken.status field in the response for the status of the scheme token stored against the gateway token.
Value must be a member of the following list. The values are case sensitive.
ASYNCHRONOUS
The gateway token is generated and immediately returned to you in the response. The network token will then be requested and, if successful, linked to the gateway token.
ATTEMPT_SYNCHRONOUS
The gateway token is generated and the network token is immediately requested. If successful, it is linked to the gateway token, and you receive the response. If unsuccessful, the gateway token is still returned, with the network token generation re-tried again later.
SYNCHRONOUS
The network token is requested immediately. If successful, the gateway token is returned in the response. Otherwise, an error response is returned and the gateway token is not created.
Session Information
ASCII Text
ALWAYS PROVIDED
The identifier of the session
Data consists of ASCII characters
Enumeration
ALWAYS PROVIDED
A summary of the outcome of the last attempt to modify the session.
In order to perform an operation using this session this value must be SUCCESS.
Value must be a member of the following list. The values are case sensitive.
FAILURE
The last attempt to place data into the session was unsuccessful. The session may contain invalid data. A request operation using this session will be rejected by the payment gateway.
NO_UPDATE
No attempt has been made to place data into the session. A request operation using this session will be rejected by the payment gateway.
SUCCESS
The last attempt to update the session was successful. You may submit a request operation using this session.
ASCII Text
ALWAYS PROVIDED
Use this field to implement optimistic locking of the session content.
Do this if you make business decisions based on data from the session and wish to ensure that the same data is being used for the request operation.
To use optimistic locking, record session.version when you make your decisions, and then pass that value in session.version when you submit your request operation to the gateway.
See Making Business Decisions Based on Session Content.
Data consists of ASCII characters
Shipping information for this order.
The address to which this order will be shipped.
String
CONDITIONAL
The city portion of the address.
Data can consist of any characters
String
CONDITIONAL
The name of the company associated with this address.
Data can consist of any characters
Upper case alphabetic text
CONDITIONAL
The 3 letter ISO standard alpha country code of the address.
Data must consist of the characters A-Z
Alphanumeric + additional characters
CONDITIONAL
The post code or zip code of the address.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
Enumeration
CONDITIONAL
Indicates whether the shipping address provided is the same as the payer's billing address.
Provide this value if you are not providing the full shipping and billing addresses, but you can affirm that they are the same or different.
The default value for this field is:
SAME - if the shipping and billing address are supplied, and all fields are the same (ignoring non-alphanumerics).
DIFFERENT - if the shipping and billing address are supplied, and at least one field is different (ignoring non-alphanumerics).
UNKNOWN - either shipping address or billing address is absent.
Value must be a member of the following list. The values are case sensitive.
DIFFERENT
The shipping and billing addresses are different.
SAME
The shipping and billing addresses are the same.
UNKNOWN
It is not known if the shipping and billing addresses are the same.
Enumeration
CONDITIONAL
How you obtained the shipping address.
Value must be a member of the following list. The values are case sensitive.
ADDRESS_ON_FILE
Order shipped to an address that you have on file.
NEW_ADDRESS
Order shipped to an address provided by the payer for this transaction.
String
CONDITIONAL
The state or province of the address.
Data can consist of any characters
String
CONDITIONAL
The three character ISO 3166-2 country subdivision code for the state or province of the address.
Providing this field might improve your payer experience for 3-D Secure payer authentication.
Data can consist of any characters
String
CONDITIONAL
The first line of the address.
For example, this may be the street name and number, or the Post Office Box details.
Data can consist of any characters
String
CONDITIONAL
The second line of the address (if provided).
Data can consist of any characters
Details of the contact person at the address the goods will be shipped to.
Email
CONDITIONAL
The contact person's email address.
The field format restriction ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
String
CONDITIONAL
The first name of the person to whom the order is being shipped.
Data can consist of any characters
String
CONDITIONAL
The last name or surname of the person to whom the order is being shipped.
Data can consist of any characters
Telephone Number
CONDITIONAL
The contact person's mobile phone or cell phone number in ITU-T E123 format, for example +1 607 1234 5678
The number consists of:
- '+'
- country code (1, 2 or 3 digits)
- 'space'
- national number ( which may embed single spaces characters for readability).
Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)
Telephone Number
CONDITIONAL
The contact person's phone number in ITU-T E123 format, for example +1 607 1234 456
The number consists of:
- '+'
- country code (1, 2 or 3 digits)
- 'space'
- national number ( which may embed single spaces characters for readability).
Data consists of '+', country code (1, 2 or 3 digits), 'space', and national number (which may embed single space characters for readability)
Enumeration
CONDITIONAL
Indicates whether the supplied name for the recipient of shipping matches the cardholder name.
Provide this value if you are not providing the full name or cardholder name, but you can affirm that they are the same or different.
Default value is UNKNOWN
Value must be a member of the following list. The values are case sensitive.
DIFFERENT
The shipping and billing addresses are different.
SAME
The shipping and billing addresses are the same.
UNKNOWN
It is not known if the shipping and billing addresses are the same.
Enumeration
CONDITIONAL
The shipping method used for delivery of this order.
Value must be a member of the following list. The values are case sensitive.
ELECTRONIC
Electronic delivery.
GROUND
Ground (4 or more days).
NOT_SHIPPED
Order for goods that are not shipped (for example, travel and event tickets)
OVERNIGHT
Overnight (next day).
PICKUP
Shipped to a local store for pick up.
PRIORITY
Priority (2-3 days).
SAME_DAY
Same day.
Alphanumeric + additional characters
CONDITIONAL
The post code or zip code of the address the order is shipped from.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
The details describing the source of the funds to be used.
For card payments these may be represented by combining one or more of the following: explicitly provided card details, a session identifier which the gateway will use to look up the card details and/or a card token. Precedence rules will be applied in that explicitly provided card details will override session card details which will override card token details. Each of these may represent partial card details, however the combination must result in a full and complete set of card details. See Using Multiple Sources of Card Details for examples.
Information about the source of funds when it is directly provided (as opposed to via a token or session).
For browser payments, the source of funds details are usually collected from the payer on the payment provider's website and provided to you when you retrieve the transaction details (for a successful transaction). However, for some payment types (such as giropay), you must collect the information from the payer and supply it here.
For ACH payments (sourceOfFunds.type=ACH) you must provide values for all fields within this parameter group, including details about the payers bank account as well as the type of ACH payment.
It is your responsibility to authenticate the payer and obtain authorization from the payer in accordance with the NACHA Operating Rules and Guidelines for the Standard Entry Class (SEC) associated with this payment. For details please refer to https://www.nacha.org/.
Enumeration
CONDITIONAL
An indicator identifying the type of bank account.
- Consumer (checking or savings), or
- Business
For pre-arranged payments (sourceOfFunds.provided.ach.secCode=PPD) retrieve this information from the payer.
If payments were telephone-initiated (sourceOfFunds.provided.ach.secCode=TEL) or internet-initiated (sourceOfFunds.provided.ach.secCode=WEB) you may choose to limit the payer's options (e.g. only support consumer checking accounts), depending on your type of business (e.g. B2C online webshop).
Value must be a member of the following list. The values are case sensitive.
CONSUMER_CHECKING
Consumer Checking Account
CONSUMER_SAVINGS
Consumer Savings Account
CORPORATE_CHECKING
Business Checking Account
String
CONDITIONAL
The name of the bank account holder, as it appears on the account at the receiving financial institution.
Retrieve this information from the payer.
Data can consist of any characters
Alphanumeric + additional characters
CONDITIONAL
The identifier of the bank account at the receiving financial institution.
Retrieve this information from the payer.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-', '/'
Digits
CONDITIONAL
The identifier of the receiving financial institution.
Also known as:
- Routing number,
- Transit number, or
- ABA number
Retrieve this information from the payer.
See also http://en.wikipedia.org/wiki/Routing_transit_number.
Data is a string that consists of the characters 0-9.
Enumeration
CONDITIONAL
Identifies the Standard Entry Class (SEC) code to be sent to the issuer.
The SEC is defined by NACHA and describes the origin and intent of the payment. For details please refer to https://www.nacha.org/.
Value must be a member of the following list. The values are case sensitive.
PPD
An ACH debit or credit payment (B2C) that has been authorized by an authenticated customer in written form (signed or similarly authenticated). PPD is used for pre-arranged payments (e.g. employee payroll, mortgage payments, expense reimbursement).
TEL
An ACH debit payment (B2C) that has been authorized by an authenticated customer via phone. TEL may only be used if a relationship already exists between you and the consumer, or, the consumer initiates the contact with you.
WEB
An ACH debit payment (B2C) that has been authorized by an authenticated customer via the internet or a wireless network.
For Alipay payments (sourceOfFunds.type=ALIPAY) you must provide values for all fields within this parameter group.
String
CONDITIONAL
Payer code is a one-time code used by Alipay to identify the payer.
It is generated by the Alipay wallet app on the payer's mobile device.
Data can consist of any characters
Additional details related to a Bancontact payment.
String
CONDITIONAL
The name of the bank account holder for the payer's bank account.
Data can consist of any characters
Additional details related to a BLIK browser payment.
String
CONDITIONAL
The name of the bank account holder for the payer's bank account.
Data can consist of any characters
Additional details related to a Boleto Bancario browser payment.
When processing a Boleto Bancario payment you must also provide the payer's national identifier (customer.nationalId), your reference to the payer (customer.id) and the payer's date of birth (customer.dateOfBirth)
Enumeration
CONDITIONAL
The action to take if the payment is not honored.
Value must be a member of the following list. The values are case sensitive.
WRITE_OFF
Write off the Boleto.
String
CONDITIONAL
The name of the bank account holder for the payer's bank account.
Data can consist of any characters
Enumeration
CONDITIONAL
Type of the Customer i.e. Individual or Company.
If the value is not provided it will be defaulted to INDIVIDUAL.
Value must be a member of the following list. The values are case sensitive.
COMPANY
Customer is an organization.
INDIVIDUAL
Customer is an individual.
Digits
CONDITIONAL
Number of days granted by you to the customer after the due date of Boleto payment before the specified action is taken.
Data is a string that consists of the characters 0-9.
Date
CONDITIONAL
The date by which the Boleto amount needs to be paid.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
Details as shown on the card.
Enumeration
CONDITIONAL
You can provide this field for card types that have a savings/checking option, such as Maestro cards.
If you do not provide a value, we will use the acquirer's default. You can use paymentTypes.card.cardTypes in the 'Retrieve Payment Options' operation response to determine the card type.
Value must be a member of the following list. The values are case sensitive.
CHECKING
SAVINGS
Details about the card that you have sourced using digital payment methods.
Use this parameter group when you have sourced payment details using:
- Device payment methods such as Apple Pay, Android Pay, Samsung Pay, or Google Pay.
- Digital wallets such as Secure Remote Commerce (Click to Pay).
- Card scheme tokens. This applies when you have tokenized the payer's card number using a card scheme tokenization service such as Mastercard Digital Enablement Service (MDES).
Enumeration
CONDITIONAL
The format of the cryptogram provided for the digital payment.Use this field for:
- • Device payments: provide the cryptogram format when you decrypt the payment token and provide the payment details (including the online payment cryptogram) in the transaction request.
This field does not apply to Card Scheme token payments.
Value must be a member of the following list. The values are case sensitive.
3DSECURE
The payment data keys for the online payment cryptogram are provided using the 3-D Secure format.
EMV
The payment data keys for the online payment cryptogram are provided using the EMV format.
Digits
CONDITIONAL
The Electronic Commerce Indicator generated for payments made using a device payment method.
You source this field directly from the decrypted payment token.
This field is not applicable for payments using digital wallets or card scheme tokens.
Data is a string that consists of the characters 0-9.
Base64
CONDITIONAL
A cryptogram used to authenticate the transaction.Use this field for:
- • Device payments: source this field directly from the decrypted payment token.
- • Card scheme tokens: source this field directly from the decrypted transaction credentials.
Data is Base64 encoded
String
CONDITIONAL
This is the payment token that you received from the device's payment SDK.
For example:
For Apple Pay - this is the PKPaymentToken.paymentData value.
For Google - this is PaymentMethodToken.getToken().
Note 1: The gateway API considers this value to be a string, NOT JSON itself. Therefore when using the JSON gateway API, this field will typically look like:
"sourceOfFunds": {
"provided": {
"card": {
"devicePayment": {
"paymentToken": "{\"data\":\"869ss19ew ....
Note 2: The gateway will ignore the currency and amount information in the payment token, and will instead use the values passed on the amount and currency fields. For normal usage, you should populate those fields with the exact same values as you got from the SDK.
Data can consist of any characters
String
CONDITIONAL
This field only applies to transactions that originate from an EMV capable terminal.
It contains selected EMV fields as provided by the terminal.
For the list of field tags to include (if provided by the terminal), see Card Present Payments. Requests with any other tags are rejected by the gateway.
Some of the tags represent data that can occur on explicit fields in this API. You can submit the value either in this field, or in both places. For example, the PAN can be presented as EMV tag 5A in this field, or included both the sourceOfFunds.provided.card.number API field and in EMV tag 5A in this field.
If you specify the EMV tag only, we can populate the explicit field in the API. Fields where this is supported have the text "This field corresponds to EMV tag <tag name>" in their field descriptions.
If you specify both places, there will be no population of the explicit field or validation that the data matches.
The API response will not contain PCI sensitive fields.
Data can consist of any characters
Expiry date, as shown on the card.
Digits
CONDITIONAL
Month, as shown on the card.
Months are numbered January=1, through to December=12.
Data is a number between 1 and 12 represented as a string.
Digits
CONDITIONAL
Year, as shown on the card.
The Common Era year is 2000 plus this value.
Data is a string that consists of the characters 0-9.
Masked digits
CONDITIONAL
The Funding Primary Account Number (FPAN) of the payer's account in 6.4 masking format, for example, 000000xxxxxx0000.
You should use this value for display on confirmation or receipt pages presented to the payer.
RequestNormally you do not need to populate this field, as the gateway will populate this field in the session, and populate it into the payment request when you submit the payment using the session. You would only provide this value, if you had access to FPAN information that was not available to the gateway. On responses, the gateway populates it with a form that the payer would recognize (also explained in more detail below).
Retrieve session response
The gateway always populates this field with its best understanding of the masked FPAN.If you are showing PAN data from the session to the payer, then use this field rather than sourceOfFunds.provided.card.number from the session. This is because this field contains a PAN that the payer will recognize whereas sourceOfFunds.provided.card.number could contain a scheme token, or device PAN which the payer will not recognize. After the payment is processed, the gateway will populate the sourceOfFunds.provided.card.number in the payment response with its best understanding of the masked FPAN. You can show this value to the payer after the payment is complete. This logic also applies to the maskedFpanExpiry field.
Data is a string that consists of the characters 0-9, plus 'x' for masking
Expiry date, The expiry date of the Funding Primary Account Number (FPAN) in sourceOfFunds.provided.card.maskedFpan.
Digits
CONDITIONAL
The expiration month for the Funding Primary Account Number (FPAN).
Months are numbered January=1, through to December=12.
Data is a number between 1 and 12 represented as a string.
Digits
CONDITIONAL
The expiration year for the Funding Primary Account Number (FPAN).
The Common Era year is 2000 plus this value.
Data is a string that consists of the characters 0-9.
If the payer chose to pay using a mobile device you must provide details from the wallet in this parameter group.
Use this parameter group when accepting payments from mobile wallet providers such as Apple Pay, Android Pay or Samsung Pay.
Cryptogram data for mobile wallet payments provided in 3DSecure format.
Digits
CONDITIONAL
The Electronic Commerce Indicator generated for the mobile wallet payment.
It indicates the level of security and authentication of the transaction.
Data is a string that consists of the characters 0-9.
Base64
CONDITIONAL
The unique transaction cryptogram generated for the mobile wallet payment.
This will be in Base64 format for MasterCard and Visa transactions and binary format for American Express transactions.
Data is Base64 encoded
Enumeration
CONDITIONAL
The format of the cryptogram provided for the device payment.
You must provide the cryptogram format when you decrypt the payment token and provide the payment details (including the online payment cryptogram) in the transaction request.
Value must be a member of the following list. The values are case sensitive.
3DSECURE
The payment data keys for the online payment cryptogram are provided using the 3-D Secure format.
EMV
The payment data keys for the online payment cryptogram are provided using the EMV format.
String
CONDITIONAL
The cardholder's name as printed on the card.
Data can consist of any characters
Digits
CONDITIONAL
Credit card number as printed on the card.
Data is a string that consists of the characters 0-9.
This holds the PAN in the case where it is encrypted by the terminal using DUKPT key exchange.
Digits
CONDITIONAL
The BIN of the card.
If you provide this, the gateway will check that the decrypted PAN has these leading six digits. If the check fails, the gateway will reject the transaction.
If you do not provided this, the gateway will not perform this check.
Data is a string that consists of the characters 0-9.
String
CONDITIONAL
The P2PE encryption state as determined by the terminal.
INVALID means the terminal detected some form of error in the encryption process. The gateway will decline transactions with INVALID encryption state. This field may be omitted when the value is VALID.
Data can consist of any characters
Hex
CONDITIONAL
The initialization vector supplied by the terminal to seed the encryption of this payload.
Omit this value if the terminal is not using an initialization vector to seed encryption.
Data is hexadecimal encoded
Hex
CONDITIONAL
The DUKPT key serial number supplied by the terminal.
Data is hexadecimal encoded
Hex
CONDITIONAL
The DUKPT encrypted payload supplied by the terminal.
Data is hexadecimal encoded
Digits
CONDITIONAL
The first 10 digits of the card number, as printed on the card.
Data is a string that consists of the characters 0-9.
Digits
CONDITIONAL
Card verification code, as printed on the back or front of the card or as provided for a card scheme token.
Data is a string that consists of the characters 0-9.
Digits
CONDITIONAL
A number used to differentiate between cards with the same Primary Account Number (PAN).
This field corresponds to EMV tag 5F34
Data is a number between 0 and 999 represented as a string.
Enumeration
CONDITIONAL
This field only applies if you collect card details from your payer, store them, and either you or your payer use the stored credentials for subsequent payments.
Refer to Credential on File, Cardholder and Merchant-initiated Transactions for details.
Value must be a member of the following list. The values are case sensitive.
NOT_STORED
Set this value if you are not storing the card details provided by the payer for this transaction. The gateway sets this value by default, if you are submitting a payer-initiated transaction. You must not use this value when submitting merchant-initiated transactions.
STORED
Set this value if you have previously stored the card details provided by the payer and are now using these stored details. The gateway sets this value by default, if you are submitting a merchant-initiated transaction.
TO_BE_STORED
Set this value if this is the first transaction using these card details and you intend to store the card details if the transaction is successful.
For Direct Debit payments in Canada you must provide the payer's bank account details in this parameter group.
Enumeration
CONDITIONAL
An indicator identifying the type of bank account.
Value must be a member of the following list. The values are case sensitive.
CONSUMER_CHECKING
Consumer Checking Account
CONSUMER_SAVINGS
Consumer Savings Account
String
CONDITIONAL
The name of the bank account holder, as it appears on the account at the receiving financial institution.
Data can consist of any characters
Alphanumeric + additional characters
CONDITIONAL
The identifier of the bank account at the receiving financial institution.
The bank account number will be returned in a masked format, for example, xxxxxxxxxxxxx123.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-', '/'
Digits
CONDITIONAL
The identifier of the receiving financial institution.
Data is a string that consists of the characters 0-9.
Digits
CONDITIONAL
The transit number identifying the branch of the receiving financial institution where the bank account is held.
Data is a string that consists of the characters 0-9.
If the payer chose to pay using a Electronic Benefits Transfer card, you must submit sourceOfFunds.type=EBT_CARD and provide the payer's card details in this parameter group.
Enumeration
CONDITIONAL
Indicates the type of benefits account used for the payment.
Value must be a member of the following list. The values are case sensitive.
CASH_BENEFITS
Benefits provided as cash.
EWIC_BENEFITS
Benefits provided under the Special Supplemental Nutrition Program for Women, Infants, and Children.
SNAP_BENEFITS
Benefits provided under the Supplemental Nutrition Assistance Program.
Digits
CONDITIONAL
Value provided to you by the EBT merchant helpline when you requested manual authorization of the payment because you were unable to authorize the payment online.
For example, your point of sale (POS) machine is not working. When you manually authorize a payment you also need to provided the voucher number used to record the payment in sourceOfFunds.provided.EBT.voucherNumber.
Data is a string that consists of the characters 0-9.
Digits
CONDITIONAL
The identifier assigned to you by the USDA Food and Nutrition Service (FNS) when they authorized you to accept EBT payments at your store.
Data is a string that consists of the characters 0-9.
Digits
CONDITIONAL
The number of the paper form (voucher) that you used to record details of an EBT payment when you were unable to authorize the payment online.
For example, your point of sale (POS) machine is not working. When you use a voucher you also need to provide an authorization code in sourceOfFunds.provided.benefits.ebt.manualAuthorizationCode.
Data is a string that consists of the characters 0-9.
Additional details related to an eNETS browser payment.
Note: if you provide data for an eNETS payment, then you must also provide an email address for the customer in customer.email and a phone number for the customer in either customer.phone or customer.mobilePhone
String
CONDITIONAL
The name of the bank account holder for the payer's bank account.
Data can consist of any characters
Additional details related to a eps-Überweisung browser payment.
Alpha
CONDITIONAL
The country where the payer has their bank account.
Provide the ISO 3166 alpha-3 country code for this country.
Data may consist of the characters a-z, A-Z
String
CONDITIONAL
The name of the bank account holder for the payer's bank account.
Data can consist of any characters
If the payer chose to pay using a gift card, you must submit sourceOfFunds.type=GIFT_CARD and provide the payer's gift card details in this parameter group.
String
CONDITIONAL
Do not provide this field in your request unless instructed to do so by tyro.
The field is required, if your gift card numbers do not use ISO BIN rules and therefore not allowing the gateway to identify the local brand.
Data can consist of any characters
Digits
CONDITIONAL
Card number as printed or embossed on the gift card.
Data is a string that consists of the characters 0-9.
Digits
CONDITIONAL
PIN number for the gift card.
Data is a string that consists of the characters 0-9.
Additional information required by the gateway to initiate a giropay browser payment.
Digits
CONDITIONAL
German bank identifier (Bankleitzahl) for the payer's bank account.
Data is a string that consists of the characters 0-9.
Alphanumeric
CONDITIONAL
The international Business Identifier Code (BIC) for the payer's bank account.
Data may consist of the characters 0-9, a-z, A-Z
Additional details related to GrabPay browser payment.
String
CONDITIONAL
The name of the account holder for the payer's GrabPay account.
Data can consist of any characters
Additional details related to an iDEAL browser payment.
When processing an iDEAL payment you can also provide the payer's bank identification code (ideal.bic),
Alphanumeric
CONDITIONAL
The international Business Identifier Code (BIC) for the payer's bank account.
Data may consist of the characters 0-9, a-z, A-Z
Additional details related to a Klarna Pay Later payment.
Upper case alphabetic text
CONDITIONAL
The country where the payer has their bank account.
Provide the ISO 3166 alpha-3 country code for this country.
Data must consist of the characters A-Z
Additional details related to a Klarna Pay Now payment.
Alpha
CONDITIONAL
The country where the payer has their bank account.
Provide the ISO 3166 alpha-3 country code for this country.
Data may consist of the characters a-z, A-Z
Additional details related to Open Banking Bank Transfer.
String
CONDITIONAL
Identifier of the payer's bank, also known as ASPSP (Account Servicing Payment Services Provider)
Data can consist of any characters
Additional details related to an OXXO browser payment.
When processing an OXXO payment you must also provide the payer's national identifier (customer.nationalId), your reference to the payer (customer.id) and the payer's date of birth (customer.dateOfBirth).
String
CONDITIONAL
The name of the bank account holder for the payer's bank account.
Data can consist of any characters
Date
CONDITIONAL
The date by which your payer has to make the payment.
Do not provide a due date for USD currency transactions.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
Additional details related to a PayU browser payment.
Alpha
CONDITIONAL
The country where the payer has their bank account.
Provide the ISO 3166 alpha-3 country code for this country.
Data may consist of the characters a-z, A-Z
String
CONDITIONAL
The name of the bank account holder for the payer's bank account.
Data can consist of any characters
Additional details related to a Payconiq payment.
Alpha
CONDITIONAL
This is the country of the payer's payconiq account.
Provide the ISO 3166 alpha-3 country code for this country.
Data may consist of the characters a-z, A-Z
Information about the payer's PayPal account.
It is provided to you when the payer successfully makes a payment using PayPal or when you have established a billing agreement with the payer.
Email
CONDITIONAL
The email address of the payer's PayPal account.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
String
CONDITIONAL
The name of the account holder of the payer's PayPal account.
Data can consist of any characters
Details about the agreement you have established with the payer that allows you to bill the payer's PayPal account for goods or services.
Enumeration
CONDITIONAL
Indicates the number of billing agreements between you and this payer.
Value must be a member of the following list. The values are case sensitive.
MULTIPLE
Indicates that you have multiple billing agreements with this payer. This means that a new agreement ID will be returned in response to each request.
SINGLE
Indicates that you have a single billing agreement with this payer. This means that the same agreement ID will be returned in response to each request.
String
CONDITIONAL
Your description for the PayPal billing agreement.
This description is displayed to the payer when they are asked to approve the billing agreement.
Data can consist of any characters
String
CONDITIONAL
An identifier provided by PayPal for the billing agreement.
Data can consist of any characters
String
CONDITIONAL
Your name for the PayPal billing agreement.
Data can consist of any characters
String
CONDITIONAL
The unique identifier for the payer assigned by PayPal.
Data can consist of any characters
Additional details related to a paysafecard browser payment.
Email
CONDITIONAL
The mypaysafecard account email identifying the mypaysafecard account that will be refunded.
Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses
Alpha
CONDITIONAL
The country where the payer has their bank account.
Provide the ISO 3166 alpha-3 country code for this country.
Data may consist of the characters a-z, A-Z
Additional details related to Pay by Bank app payment.
Url
CONDITIONAL
The URL of merchant app to which the payer is redirected from their mobile banking app.
Ensure that this is a valid URL according to RFC 1738.
Additional details related to a POLi browser payment.
String
CONDITIONAL
The name of the bank account holder for the payer's bank account.
Data can consist of any characters
Additional details related to a Przelewy24 browser payment.
String
CONDITIONAL
The name of the bank account holder for the payer's bank account.
Data can consist of any characters
Details about the payer's bank account used for a payment made using SEPA
String
CONDITIONAL
The name of the bank account holder for the payer's bank account.
Data can consist of any characters
Alphanumeric
CONDITIONAL
The international Business Identifier Code (BIC) for the payer's bank account.
Data may consist of the characters 0-9, a-z, A-Z
String
CONDITIONAL
The International Bank Account Number (IBAN) for the payer's bank account.
By default, the bank account number will be returned in a masked format, for example, xxxxxx0000. If you wish to return unmasked bank account numbers, you must have the requisite permission, set responseControls.sensitiveData, and authenticate your call to the API using certificate authentication. Contact tyro for further information.
Data can consist of any characters
Additional details related to a Sofort (Klarna) payment.
Upper case alphabetic text
CONDITIONAL
The country where the payer has their bank account.
Provide the ISO 3166 alpha-3 country code for this country.
Data must consist of the characters A-Z
Additional details related to a Trustly.
Alpha
CONDITIONAL
The country where the payer has their bank account.
Provide the ISO 3166 alpha-3 country code for this country.
Data may consist of the characters a-z, A-Z
String
CONDITIONAL
The name of the bank account holder for the payer's bank account.
Data can consist of any characters
Additional details related to a WeChat Pay browser payment.
String
CONDITIONAL
The name of the account holder for the payer's WeChat Pay account.
Data can consist of any characters
ASCII Text
CONDITIONAL
You only must provide this field if you want the gateway to retrieve a scheme token for card details that your payer has made available to you via their card issuer (i.e. push provisioning of scheme tokens).
Using the identifier provided by the issuer, the gateway will retrieve the scheme token details from the token service provider and store them against the gateway token.
When providing this field, you must not provide card details in the sourceOfFunds.provided.card parameter group, and you must set the sourceOfFunds.type field to CARD.
Data consists of ASCII characters
Alphanumeric
CONDITIONAL
A gateway token that contains account identifier details.
The account identifier details stored against this token will be used to process the request.
If account identifier details are also contained in the request, or the request contains a session with account identifier details, these take precedence over the details stored against the token.
Data may consist of the characters 0-9, a-z, A-Z
Alphanumeric
CONDITIONAL
The unique identifier assigned to you by the Token Service Provider that you requested a token from for this payment.
This field is mandatory for payments where the Chase Pay wallet was used.
Data may consist of the characters 0-9, a-z, A-Z
Enumeration
CONDITIONAL
The payment method used for this payment.
If you are passing card data (in any form) on the API, then you need to set this value, and also provide the card details in the sourceOfFunds.provided.card group. In the case of digital wallets or device payment methods, you must also populate the order.walletProvider field.
If you are making a payment with a gateway token, then you can leave this field unset, and only populate the sourceOfFunds.token field. However you can set this to CARD if you want to overwrite or augment the token data with a card security code, expiry date, or cardholder name.
Value must be a member of the following list. The values are case sensitive.
ACH
The payer chose to pay using an electronic fund transfer, to be processed via the Automated Clearing House (ACH) Network. You must provide the payer's bank account details and information about the type of ACH payment under the sourceOfFunds.provided.ach parameter group.
ALIPAY
The payer selected the payment method Alipay.
BANCANET
The payer selected the payment method BancaNet Directo.
BANCONTACT
The payer selected the payment method Bancontact.
BLIK
The payer selected the payment method BLIK.
BOLETO_BANCARIO
The payer selected the payment method Boleto Bancario.
BROWSER_PAYMENT
The payer selected to pay using a browser payment. Refer to the sourceOfFunds.browserPayment parameter group for additional details.
CARD
Use this value for payments that obtained the card details either directly from the card, or from a POS terminal, or from a wallet, or through a device payment method.
DIRECT_DEBIT_CANADA
The payer chose to pay using Direct Debit in Canada, also known as pre-authorized bank debits (PADs). You must provide the payer's bank account details in the sourceOfFunds.provided.directDebitCanada parameter group.
EBT_CARD
Use this value for Electronic Benefits Transfer (EBT) card payments. The additional EBT data must also be provided in the sourceOfFunds.provided.ebt parameter group.
ENETS
The payer selected the payment method eNETS.
EPS_UEBERWEISUNG
The payer selected the payment method eps-Überweisung.
GIFT_CARD
The payer chose to pay using a gift card. The payer's gift card details must be provided under the sourceOfFunds.provided.giftCard parameter group.
GIROPAY
The payer selected the payment method giropay.
GRABPAY
The payer selected the payment method GrabPay.
IDEAL
The payer selected the payment method iDEAL.
KLARNA_FINANCING
The payer selected the payment method Klarna financing.
KLARNA_PAY_LATER
The payer selected the payment method Klarna Pay Later.
KLARNA_PAY_NOW
The payer selected the payment method Klarna Pay Now.
MERCADO_PAGO_CHECKOUT
The payer selected the payment method Mercado Pago Checkout.
MULTIBANCO
The payer selected the payment method Multibanco.
OPEN_BANKING_BANK_TRANSFER
The payer selected the payment method Open Banking Bank Transfer.
OXXO
The payer selected the payment method OXXO.
PAYCONIQ
The payer selected the payment method payconiq.
PAYPAL
The payer selected the payment method PayPal.
PAYSAFECARD
The payer selected the payment method paysafecard.
PAYU
The payer selected the payment method PayU.
PBBA
The payer selected the payment method Pay by Bank app
POLI
The payer selected the payment method POLi.
PRZELEWY24
The payer selected the payment method Przelewy24.
SCHEME_TOKEN
Use this value for payments using scheme tokens provided by Mastercard Digital Enablement Service (MDES), or Visa Token Service (VTS), or American Express Token Service (AETS).
SEPA
The payer selected the payment method SEPA.
SOFORT
The payer selected the payment method Sofortbanking.
TRUSTLY
The payer selected the payment method Trustly.
Provide these parameters if you are a payment aggregator or facilitator and process payments on behalf of other merchants.
These merchants are referred to as your sub merchants. The sub merchant's details you provide may be displayed on the payer's cardholder statement. The gateway will use separate token repositories for each of your sub merchants
Alphanumeric + additional characters
CONDITIONAL
Your identifier for the sub-merchant.
Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '.'
Alphanumeric
CONDITIONAL
The token you supply that you wish to create or update.
You can only supply this value when creating a token if your token repository is configured to support merchant-supplied tokens.
On response, the format of the token depends on the token generation strategy configured for your repository. See Tokenization for more details.
Data may consist of the characters 0-9, a-z, A-Z
Information about this transaction.
Additional information to be passed to acquirer.
String
CONDITIONAL
Additional information requested by the acquirer which cannot be passed using other available data fields.
This field must not contain sensitive data.
Data can consist of any characters, but sensitive data will be rejected
String
CONDITIONAL
The unique identifier that allows the issuer to link related transactions.
Typically the gateway takes care of submitting this identifier to the issuer on your behalf. However, you must submit this identifier if you have processed the payer-initiated transaction (also called CIT) for the payment agreement outside the gateway or you are submitting a Refund where the Authorization or Payment has been performed outside the gateway.
For a Mastercard transaction this identifier must contain the scheme issued transaction identifier, network code and network date, and is also known as the Trace ID. For a Visa or American Express transaction this identifier matches the scheme issued transaction identifier, also known as Transaction Identifier or TID. Refer to the scheme's documentation for more details.
Payment in a Series
You must provide the information returned in the Authorization/Payment/Verification response for the last payer-initiated transaction in the series (CIT).
Refund
You must provide the information returned in the Authorization/Payment response for the payment for which you are issuing a refund.
Resubmission
For resubmission transactions, the gateway will include the scheme transaction identifier from the failed transaction.
However, you may use this field to directly provide the scheme transaction identifier to be used on the resubmission in certain scenarios:
- Original failed transaction was processed outside the gateway.
- Multiple failed authorizations exist on the order and the resubmission needs to refer to a failed transaction which is not the latest.
Data can consist of any characters, but sensitive data will be rejected
String
CONDITIONAL
This is the value provided to the acquirer to identify the order.
Ideally this will be the order.id, however if that value cannot be used directly, it will be transformed by the gateway to a unique value that the acquirer will accept. If that behavior is not suitable, you can directly provide the value in this field and it will be passed to the acquirer. You then take responsibility for its correctness. (Note: contact your payment provider to see if this is supported for your acquirer).
Data can consist of any characters, but sensitive data will be rejected
Decimal
CONDITIONAL
Transaction Amount.
Expressed as a decimal number in the units of the currency. For example 12.34 in USD is the amount 12 dollars and 34 cents.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Comma separated enumeration
CONDITIONAL
The action you want the gateway to take if you submit a capture amount that is different from the outstanding authorization amount for the order.
You only need to provide a value if you want to restrict the action taken and understand the relevant scheme rules.
The default value for this field is INCREMENT. In this case, the gateway will automatically submit an update authorization request to the acquirer if the requested capture amount exceeds the outstanding authorized amount. If the update was successfully authorized, the gateway then attempts the capture.
Set this value to NO_ACTION to prevent the gateway performing any authorization adjustments.
Note: You might need tyro to enable these capabilities on your gateway merchant profile.
Value must be one or more comma separated members of the following list. The values are case sensitive.
INCREMENT
Increase the authorized amount to match the total capture amount.
NO_ACTION
Do not perform any authorization adjustments.
Alphanumeric
CONDITIONAL
Value generated by the issuing bank in response to a proposal to transfer funds.
Data may consist of the characters 0-9, a-z, A-Z
Additional information the gateway requires to initiate a BancaNet browser payment.
String
CONDITIONAL
The payment reference for the payment.
The format depends on your BancaNet Directo account (Servicio Electrónico de Pagos or Concentración de Fondos).
Data can consist of any characters
Date
CONDITIONAL
The date by when the payer should make the payment.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
String
CONDITIONAL
The reason for the payment, for example, 'Pago de tarjeta', which is displayed to the payer on the BancaNet website.
Data can consist of any characters
Upper case alphabetic text
CONDITIONAL
The currency which should be used for acquirer card verification.
Not required for basic verification.
Data must consist of the characters A-Z
Boolean
CONDITIONAL
Indicates that you were not able to submit the Authorization (or Payment) transaction at the time it was completed with the cardholder due to a connectivity, system issue, or other limitations and have deferred submitting it until your system was back online.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
Decimal
CONDITIONAL
The total amount deducted from the transaction amount that would normally apply.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Decimal
CONDITIONAL
The duty amount (also known as customs tax, tariff or dues) for the transaction.
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
String
CONDITIONAL
Unique identifier for this transaction to distinguish it from any other transaction on the order.
An order can have transactions representing:
- Movement of money. For example, payments and refunds.
- Validations. For example, account verification or 3-D Secure authentication of the payer.
- Undoing other transactions. For example, voiding a payment transaction.
- Chargebacks.
- Fees from tyro.
If you attempt an operation and it fails (eg you try to PAY on a card with no funds), then you need a new id for each retry.
Data can consist of any characters
Information about the items the payer purchases with the order.
String
CONDITIONAL
The brand of the item.
For example, Dell.
Data can consist of any characters
String
CONDITIONAL
Your category for the item.
Data can consist of any characters
String
CONDITIONAL
Description for the item with information such as size, color, etc.
For example, 'Color:Red, Size:M'
Data can consist of any characters
Only use this parameter group to provide additional line item details required for a better interchange rate for Purchasing Cards, Business and/or Corporate Cards (Level 3).
Check with tyro if Level 3 data is supported for your acquirer.
JSON Text
CONDITIONAL
Use this field to provide line item details that your acquirer requires you to provide.
Data must be provided in JSON format using the record name and field name (separated by a comma) to identify the value provided. Contact tyro for details about the supported fields including the field definitions.
Data is valid Json Format
Digits
CONDITIONAL
A code describing a commodity or a group of commodities pertaining to goods classification.
Data is a number between 1 and 9999999999999999 represented as a string.
Information about the taxes per line item.
Decimal
CONDITIONAL
The tax amount for the tax type defined in order.item[n].detail.tax[m].type for the item.
Note that the tax amount provided must reflect the tax amount applied before a discount was applied.
Data is a string that consists of the characters 0-9, '.' and '-' and represents a valid decimal number.
Decimal
CONDITIONAL
The tax rate (percentage) applied to the item for the tax type defined in order.item[n].detail.tax[m].type.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
CONDITIONAL
The tax type for which the amount specified under order.item[n].detail.tax[m].amount has been paid for this item.
The correct value as used by your acquirer may have to be provided. Contact tyro for details.
Data can consist of any characters
Decimal
CONDITIONAL
The discount rate (percentage) applied to this item.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Decimal
CONDITIONAL
The tax rate (percentage) of the tax charged for this item.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
CONDITIONAL
The type of tax charged for this item.
The correct value as used by your acquirer may have to be provided. Contact tyro for details.
Data can consist of any characters
Digits
CONDITIONAL
The United Nations Standard Products and Services Code (UNSPSC) for the item.
Data is a number between 1 and 9999999999999999 represented as a string.
Digits
CONDITIONAL
The Universal Product Code (UPC) for the item.
Data is a number between 1 and 9999999999999999 represented as a string.
Enumeration
CONDITIONAL
Provide the industry category to send this line item to your acquirer for specialized processing as industry data.
Such processing might have legal obligations, which are your responsibility. Do not provide an industry category, unless you are certain it applies to you, and is accepted by your acquirer.
We support the following industry standard processing:US health care processing using the IIAS standard.The supported values for this field are:HEALTHCARE_VISION, HEALTHCARE_DENTAL, HEALTHCARE_PRESCRIPTION, HEALTHCARE_OTHERWe formulate an IIAS message by summing the amounts of all the line items with the same industry category. The amount of a line item is computed as:(order.item.unitPrice + order.item.tax) * order.item.quantity
Value must be a member of the following list. The values are case sensitive.
HEALTHCARE_DENTAL
HEALTHCARE_OTHER
HEALTHCARE_PRESCRIPTION
HEALTHCARE_VISION
String
CONDITIONAL
A short name describing the item.
Data can consist of any characters
Decimal
CONDITIONAL
The quantity of the item.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number greater than zero.
String
CONDITIONAL
The SKU (Stock Keeping Unit) or the item identifier for this item.
Data can consist of any characters
Decimal
CONDITIONAL
The discount amount applied to this item.
Data is a string that consists of the characters 0-9, '.' and '-' and represents a valid decimal number.
String
CONDITIONAL
The unit of measure used for the item quantity.
The correct value as used by your acquirer may have to be provided. Contact tyro for details.
Data can consist of any characters
Decimal
CONDITIONAL
The cost price for the item.
This amount is multiplied with the item quantity (item.quantity) to determine the total amount for this item (item.amount). This amount does not include the tax amount and/or discount amount applicable to this item.
Data is a string that consists of the characters 0-9, '.' and '-' and represents a valid decimal number.
Decimal
CONDITIONAL
The tax amount for the item.
This amount is multiplied with the item quantity (item.quantity) to determine the total tax amount for this item.
Data is a string that consists of the characters 0-9, '.' and '-' and represents a valid decimal number.
Decimal
CONDITIONAL
The total item amount for this transaction.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
CONDITIONAL
Your note about this transaction.
Data can consist of any characters
Information about Foreign Exchange (FX) rates provided by your Multi-Currency Pricing service provider.
Information about the Foreign Exchange (FX) rate that was used to calculate the amounts for this payment.
String
CONDITIONAL
Unique identifier for the Foreign Exchange (FX) rate quote as returned in the SHOPPING_OPTIONS_INQUIRY response.
Data can consist of any characters
Enumeration
CONDITIONAL
Indicates if the payer provided consent for storing the payment details they have provided for this payment.
Value must be a member of the following list. The values are case sensitive.
MERCHANT_INITIATED_PAYMENTS
The payer has provided consent for storing their card details for the purpose of subsequent merchant-initiated payments.
PAYER_DECLINED
The payer declined to provide consent for storing their card details.
PAYER_INITIATED_PAYMENTS
The payer has provided consent for storing their card details for the purpose of subsequent payer-initiated payments.
Enumeration
CONDITIONAL
Indicates that a transaction requires approval to proceed with the order.
Value must be a member of the following list. The values are case sensitive.
REQUESTED
Requested
String
CONDITIONAL
An optional identifier for this transaction.
Data can consist of any characters
Information about transactions related to this transaction.
For example, if this transaction is a merchant-initiated transaction, then this parameter group may contain information about the initial cardholder-initiated transaction.
Information about the first cardholder-initiated transaction (also called CIT) in a series of payments (MIT).
Enumeration
CONDITIONAL
Indicates the channel of authorization of first cardholder-initiated transaction (also called CIT) in a series of payments (MIT).
You must provide the channel information in this field (along with transaction.acquirer.traceId API field) if you have processed the cardholder-initiated transaction (also called CIT) for the payment agreement outside the gateway.
For example, set this value in your merchant-initiated transaction (MIT) to MOTO if the cardholder-initiated transaction (CIT) was Mail Order Telephone Order.
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
MAIL_ORDER
Transaction received by mail.
MOTO
Transaction received by mail or telephone.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.
Boolean
CONDITIONAL
Indicates that this merchant initiated transaction is a resubmission for a previous authorization which failed due to insufficient funds.
A resubmission transaction must also contain the 'scheme transaction Id' from the associated failed transaction. You can provide the referenceOrderId of the relevant order and the gateway will include the 'scheme transaction Id' of the last failed authorization on the order in the resubmission transaction. Alternatively, you can provide the 'scheme transaction Id' of the failed transaction in the resubmission transaction using the field transaction.acquirer.traceId.
The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)
Use this parameter group when transaction service location is different than your registered business location.
String
CONDITIONAL
The city where cardholder received the service.
Data can consist of any characters
Upper case alphabetic text
CONDITIONAL
The country where cardholder received the service.
Data must consist of the characters A-Z
Alphanumeric + additional characters
CONDITIONAL
The zip or postal code where cardholder received the service.
Data may consist of the characters 0-9, a-z, A-Z, ' ', '-'
String
CONDITIONAL
The state or province where cardholder received the service.
The value must match the second part of the ISO 3166-2 code. For an address in the United States provide the 2-letter ISO 3166-2 state code. For US military bases provide one of AE, AA, AP. For an address in Canada provide the 2-letter ISO 3166-2 province code.
Data can consist of any characters
Decimal
CONDITIONAL
The total shipping and handling amount for the transaction, including taxes on the shipping and/or handling.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Decimal
CONDITIONAL
The tax amount levied on the shipping and handling amount for the transaction.
This amount is included in the shipping and handling amount provided in field transaction.shippingAndHandlingAmount.
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
Decimal
CONDITIONAL
The tax rate applied to the shipping and handling amount for the transaction to determine the shipping and handling tax amount.
For a tax rate of 2.5% provide 0.025.
A sequence of digits 0-9 separated by a '.' as a decimal indicator. Leading and trailing zeroes are optional. If the fractional part is zero, the '.' and following zero(es) can be omitted. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#decimal.)
Enumeration
CONDITIONAL
Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT. You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by tyro.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.
String
CONDITIONAL
The identifier of the source transaction that you wish to reference in this transaction.
That is the {transactionId} URL field for REST and the transaction.id field for NVP.
For example: This can be the transaction id of the contactless transaction which was processed with a single tap indicator and you want to provide the PIN in this request.
Data can consist of any characters
Use this parameter group to provide a breakdown of tax types, amount per tax type, and rate per tax type included in transaction.taxAmount.
Decimal
CONDITIONAL
The tax amount included in this transaction for the tax type.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Decimal
CONDITIONAL
The tax rate (percentage) used to determine the tax amount included in this transaction for the tax type.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
String
CONDITIONAL
The type of tax included in the transaction amount.
The correct value as used by your acquirer may have to be provided. Contact tyro for details.
Data can consist of any characters
Decimal
CONDITIONAL
The total tax amount for the transaction.
You only need to provide this field when you capture or refund part of the order amount. In this case, the amount must not exceed order.taxAmount. If you provide this field when you capture or refund the full amount of the order, then the value provided must match order.taxAmount.
Data is a string that consists of the characters 0-9 and '.' and represents a valid decimal number.
Enumeration
CONDITIONAL
Indicates your tax status for this transaction.
Value must be a member of the following list. The values are case sensitive.
EXEMPT
Indicates that you are exempt from tax.
NOT_EXEMPT
Indicates that you are not exempt from tax.
NOT_PROVIDED
Indicates that you are not providing information about being exempt from tax.
Only use the functionality provided in this parameter group if you are a merchant with a card scheme approved Merchant Category Code for Aggregated Transit Fare Collection functionality.
Where the transit fare is not known at the time of travel, you can aggregate these contactless payments within limitations (time periods, amounts) as specified by the card schemes.
Use this parameter group to provide details about an aggregated transit fare or a merchant-initiated, tap-initiated or payer-initiated debt recovery for an aggregated transit fare.
Date
CONDITIONAL
This is the start date of an aggregation and matches the date of the first travel or first tap within the aggregation period.
Data must comply with ISO 8601 extended date format, yyyy-mm-dd
Enumeration
CONDITIONAL
Provide the transport mode used by the payer for the first trip when fare collection is aggregated across one or more trips as well as for merchant-initiated debt recovery transactions.
Value must be a member of the following list. The values are case sensitive.
CABLE_CAR
Cable Car
COACH
Coach
COMMUTER_TRAIN
Commuter Train
EXPRESS_COMMUTER_TRAIN
Express Commuter Train
FUNICULAR_TRAIN
Funicular Train
HIGH_SPEED_TRAIN
High Speed Train
INTERURBAN_BUS
Interurban Bus
INTER_CITY
Inter City
LIGHT_TRAIN_MASS_TRANSIT
Light Train Mass Transit
LOCOMOTIVE
Locomotive
OTHER
Other
PARA_TRANSIT
Para Transit
PARKING
Parking
POWERED_MOTOR_VEHICLE
Powered Motor Vehicle
REGIONAL_TRAIN
Regional Train
RURAL_BUS
Rural Bus
SELF_DRIVE_VEHICLE
Self Drive Vehicle
TAXI
Taxi
TOLL
Toll
TRAILER
Trailer
TRAIN
Train
URBAN_BUS
Urban Bus
WATER_BORNE_VEHICLE
Water Borne Vehicle
Enumeration
CONDITIONAL
Indicates if this is a transaction for an aggregated transit fare or a merchant-initiated, tap-initiated or payer-initiated debt recovery for an aggregated transit fare.
Value must be a member of the following list. The values are case sensitive.
DEBT_RECOVERY_MERCHANT_INITIATED
Transaction for a debt recovery for an aggregated transit fare initiated by you (according to the scheme rules).
DEBT_RECOVERY_PAYER_INITIATED
Transaction for a debt recovery for an aggregated transit fare that is initiated by the payer paying off an outstanding debt, for example, via a website or a ticket machine.
DEBT_RECOVERY_TAP_INITIATED
Transaction for a debt recovery for an aggregated transit fare that is initiated by the payer attempting to use their card or mobile device for travel and where the card has an outstanding debt.
FARE
Transaction for an aggregated transit fare that you are submitting either at the start of the travel period (for a nominal amount) or at the end of the travel period (for the total aggregated amount).
FIRST_RIDE_RISK
Transaction fare recovery which falls under the first ride risk framework.
Where the transit fare is known at the time of travel, you must indicate that this is a known fare transaction.
Enumeration
CONDITIONAL
Indicates if this is a transaction for a known fare submitted at the time of travel or after the payer has already gained access to the transit service (deferred Authorization).
Value must be a member of the following list. The values are case sensitive.
DEBT_RECOVERY_MERCHANT_INITIATED
Transaction for a debt recovery for an known transit fare initiated by Merchant (according to the scheme rules).
DEBT_RECOVERY_PAYER_INITIATED
Transaction for a debt recovery for an known transit fare initiated by payer (according to the scheme rules).
DEBT_RECOVERY_TAP_INITIATED
Transaction for a debt recovery for an known transit fare tap initiated (according to the scheme rules).
FARE_DEFERRED_AUTHORIZATION
Known transit fare payment where you are submitting the Authorization after the payer has already gained access to the transit service (deferred Authorization).
FARE_REAL_TIME_AUTHORIZATION
Known transit fare payment where you are submitting the Authorization at the time of travel.
FIRST_RIDE_RISK
Transaction fare recovery which falls under the first ride risk framework.
Enumeration
CONDITIONAL
Indicates the channel through which you received authorization for the payment for this order from the payer.
For example, set this value to INTERNET if the payer initiated the payment online.
If you have an existing agreement with the payer that authorizes you to process this payment (for example, a recurring payment) then set this value to MERCHANT. You only need to provide transaction.source if you want to override the default value configured for your acquirer link.
Note:
- You can only override the default value if you have the requisite permission.
- The value you provide must match one of those configured by tyro.
- You can only set the transaction source on the initial transaction on an order. It cannot be changed on subsequent transactions.
Value must be a member of the following list. The values are case sensitive.
CALL_CENTRE
Transaction conducted via a call centre.
CARD_PRESENT
Transaction where the card is presented to the merchant.
INTERNET
Transaction conducted over the Internet.
MAIL_ORDER
Transaction received by mail.
MERCHANT
Transaction initiated by you based on an agreement with the payer. For example, a recurring payment, installment payment, or account top-up.
MOTO
Transaction received by mail or telephone.
PAYER_PRESENT
Transaction where a non-card payment method is presented to the Merchant.
TELEPHONE_ORDER
Transaction received by telephone.
VOICE_RESPONSE
Transaction conducted by a voice/DTMF recognition system.
Enumeration
CONDITIONAL
The strategy used to verify the payment instrument details before they are stored.
You only need to specify the verification strategy if you want to override the default value configured for your merchant profile. When the verification strategy is
- BASIC you must also provide the card expiry date in the sourceOfFunds.provided.card.expiry parameter group.
- ACQUIRER you must also provide the card expiry date in the sourceOfFunds.provided.card.expiry parameter group and the currency in the transaction.currency field.
- ACCOUNT_UPDATER you must also provide a currency in the transaction.currency field and the sourceOfFunds parameter group is optional.
- you need to be enabled for Account Updater by tyro.
- you can subsequently inquire about any updates the gateway has made to the token based on the Account Updater response using the RETRIEVE_TOKEN or SEARCH_TOKENS operations.
Used to nominate which type of Verification to use when payment instrument details are stored in the token repository. This setting overrides the default settings in Merchant Manager.
Value must be a member of the following list. The values are case sensitive.
ACCOUNT_UPDATER
The gateway does not perform any validation or verification of the payment details provided, but schedules an Account Updater request to your acquirer to check for any updates to the payment details stored against the token. Once the Account Update request has been executed and indicates that the payment details have changed, the gateway automatically updates the payment details stored against the token or marks the token as invalid.
ACQUIRER
The gateway performs a Web Services API Verify request. Depending on the payment type, you may need to provide additional details to enable the submission of a Verify request.
BASIC
The gateway verifies the syntax and supported ranges of the payment instrument details provided, .e.g for a card it validates the card number format and checks if the card number falls within a valid BIN range.
NONE
The gateway does not perform any validation or verification of the payment instrument details provided.
Provide the details for the Amex Express Checkout Wallet.
String
CONDITIONAL
An Amex Express Checkout authorization code.
You need this to get the customer details from Amex Express Checkout.Get this value from the Amex Express Checkout Success callback, after the Amex Express Checkout interaction is completed.
Data can consist of any characters
String
CONDITIONAL
The type of card the payer selects for the payment.
Get this value from the Amex Express Checkout Success callback, after the Amex Express Checkout interaction is completed..
Data can consist of any characters
String
CONDITIONAL
A unique identifier provided for end to end tracking of an Amex Express Checkout interaction.
Get this value from the Amex Express Checkout Success callback, after the Amex Express Checkout interaction is completed.
Data can consist of any characters
String
CONDITIONAL
The identifier of the wallet from which the payer selects their card.
Get this value from the Amex Express Checkout Success callback, after the Amex Express Checkout interaction is completed.
Data can consist of any characters
Response fields from MasterPass operations.
String
CONDITIONAL
The card types supported for the merchant.
You provide this value when you initiate a MasterPass interaction to limit the card types that the payer can select to those supported by the merchant.
Data can consist of any characters
Url
CONDITIONAL
The MasterPass URL the gateway will use to retrieve the cardholder's payment details into the session.
Ensure that this is a valid URL according to RFC 1738.
String
CONDITIONAL
A wallet token provided by the gateway for Masterpass paired accounts.
Save this token and use it in the Retrieve Wallet Options request to obtain pre-checkout data from the payer's wallet for future interactions.
Data can consist of any characters
String
CONDITIONAL
The merchant's MasterPass Checkout Identifier required to initiate a MasterPass wallet interaction.
You provide this value on order to initiate a MasterPass interaction.
Data can consist of any characters
String
CONDITIONAL
Provide the value of the field oauthToken as returned by the MasterPass lightbox.
The gateway will use this, to retrieve the payer's payment details for the respective interaction from MasterPass and store them against the payment session (identified in field session.id). Mandatory for the MASTERPASS_ONLINE Wallet Provider.
Data can consist of any characters
String
CONDITIONAL
Provide the value of the field oauthVerifier as returned by the MasterPass lightbox.
The gateway will use this, to retrieve the payer's payment details for the respective interaction from MasterPass and store them against the payment session (identified in field session.id). Mandatory for the MASTERPASS_ONLINE Wallet Provider.
Data can consist of any characters
Url
CONDITIONAL
The URL of the page that will initialize the MasterPass lightbox.
Ensure that this is a valid URL according to RFC 1738.
Enumeration
CONDITIONAL
Indicates whether payer authentication is required for the MasterPass Express Checkout interaction.
Value must be a member of the following list. The values are case sensitive.
NOT_REQUIRED
This operation does not require further payer authentication.
REQUIRED
This operation requires further payer authentication.
String
CONDITIONAL
The MasterPass request token required to initiate a MasterPass wallet interaction.
You provide this value in order to initiate a MasterPass interaction.
Data can consist of any characters
Url
CONDITIONAL
The URL of the outer or parent page that will initialize the MasterPass lightbox.
Provide this field only when the Lightbox will be invoked from a frame that's on a merchant site, and when that frame has a different domain than the merchant site.
Ensure that this is a valid URL according to RFC 1738.
Parameters used to obtain wallet details from MasterPass for an Express Checkout interaction.
The wallet details are added to the session.
String
CONDITIONAL
A wallet token provided by the gateway for Masterpass paired accounts.
Provide this token to obtain pre-checkout data from the payer's wallet for future interactions.
Data can consist of any characters
String
CONDITIONAL
The MasterPass identifier for the card.
Provide this value to MasterPass in the cardId parameter when you initiate a 'Connected Checkout' or 'Express Checkout' MasterPass interaction for this wallet.
Data can consist of any characters
String
CONDITIONAL
The MasterPass identifier for the shipping address.
Provide this value to MasterPass in the shippingId parameter when you initiate a 'Connected Checkout' or 'Express Checkout' MasterPass interaction for this wallet.
Data can consist of any characters
Url
CONDITIONAL
The URL of the page that will initialize the MasterPass lightbox.
Ensure that this is a valid URL according to RFC 1738.
String
CONDITIONAL
A MasterPass transaction identifier.
Provide this value to MasterPass when you initiate a 'Connected Checkout' or 'Express Checkout' MasterPass interaction for this wallet.
Data can consist of any characters
Url
CONDITIONAL
The URL of the outer or parent page that will initialize the MasterPass lightbox.
Provide this field only when the Lightbox will be invoked from a frame that's on a merchant site, and when that frame has a different domain than the merchant site.
Ensure that this is a valid URL according to RFC 1738.
Response fields from SecureRemoteCommerce operations.
Enumeration
CONDITIONAL
Identifies the scheme for which the SRC Correlation ID is provided.
Value must be a member of the following list. The values are case sensitive.
AMERICAN_EXPRESS
American Express
MASTERCARD
Mastercard
VISA
Visa
String
CONDITIONAL
The unique identifier assigned by the Secure Remote Commerce (SRC) System for the interaction.
This identifier is used by the gateway to retrieve the payer's payment details.
Data can consist of any characters
Response fields from Visa Checkout Open Wallet operation.
String
CONDITIONAL
Provide the value of the field callId as returned by the Visa Checkout lightbox.
The gateway will use this, to retrieve the payer's payment details for the respective interaction from Visa Checkout and store them against the payment session (identified in field session.id). Mandatory for the VISA_CHECKOUT Wallet Provider.
Data can consist of any characters
String
CONDITIONAL
Card artwork details as returned by Visa Checkout, including the URL of the card art, and height and width of the card art in pixels, for example {"cardArt":[{"baseImageFileName":"<Image URL>","height":50,"width":77}]}.
Data can consist of any characters
String
CONDITIONAL
Card brand returned by Visa Checkout indicating the card brand selected by the payer at Visa Checkout.
Data can consist of any characters
Errors Copied to clipboard
Information on possible error conditions that may occur while processing an operation using the API.
Enumeration
Broadly categorizes the cause of the error.
For example, errors may occur due to invalid requests or internal system failures.
Value must be a member of the following list. The values are case sensitive.
INVALID_REQUEST
The request was rejected because it did not conform to the API protocol.
REQUEST_REJECTED
The request was rejected due to security reasons such as firewall rules, expired certificate, etc.
SERVER_BUSY
The server did not have enough resources to process the request at the moment.
SERVER_FAILED
There was an internal system failure.
String
Textual description of the error based on the cause.
This field is returned only if the cause is INVALID_REQUEST or SERVER_BUSY.
Data can consist of any characters
String
Indicates the name of the field that failed validation.
This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.
Data can consist of any characters
String
Indicates the code that helps the support team to quickly identify the exact cause of the error.
This field is returned only if the cause is SERVER_FAILED or REQUEST_REJECTED.
Data can consist of any characters
Enumeration
Indicates the type of field validation error.
This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.
Value must be a member of the following list. The values are case sensitive.
INVALID
The request contained a field with a value that did not pass validation.
MISSING
The request was missing a mandatory field.
UNSUPPORTED
The request contained a field that is unsupported.
Enumeration
A system-generated high level overall result of the operation.
Value must be a member of the following list. The values are case sensitive.
ERROR
The operation resulted in an error and hence cannot be processed.